Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate documentation using Puppet Strings #249

Open
jpogran opened this issue May 8, 2020 · 2 comments
Open

Generate documentation using Puppet Strings #249

jpogran opened this issue May 8, 2020 · 2 comments
Labels
enhancement New feature or request pending-1.0 Work that needs 1.0 to land before it can be worked on

Comments

@jpogran
Copy link
Contributor

jpogran commented May 8, 2020

Generate documentation using Puppet Strings

  1. A standalone command (e.g. Puppet : Generate Module Documentation)

  2. Possibly a standalone command to generate documentation for the currently edited file (e.g. Puppet : Preview documentation for this file), which would create a virtual, Read Only markdown document. Similar to the current Preview Markdown command.

  3. An optional client side event watcher for File -> Save. And then depending on the file, automatically generate the module documentation. This would be behind a setting as you probable wouldn't want this on by default.

Also it should only be active if you're in a module.

Originally posted by @glennsarti in https://github.com/puppetlabs/puppet-vscode/issues/153#issuecomment-549338625

@jpogran jpogran added the enhancement New feature or request label May 8, 2020
@jpogran
Copy link
Contributor Author

jpogran commented May 8, 2020

Created new issue in editor-services instead of moving original issue because it will require implementation in both places

@glennsarti glennsarti added this to the 1.0.0 milestone May 9, 2020
@glennsarti
Copy link
Contributor

This is a 1.0 feature (1.0 heavily depends of Puppet Strings.)

@jpogran jpogran added the pending-1.0 Work that needs 1.0 to land before it can be worked on label May 28, 2020
@jpogran jpogran removed this from the 1.0.0 milestone May 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request pending-1.0 Work that needs 1.0 to land before it can be worked on
Projects
None yet
Development

No branches or pull requests

2 participants