(PDOC-206) support for tasks #161
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@jbondpdx since we've never documented tasks in markdown, i thought you might wanna have a look. here's a sample task json: {
"description": "Allows you to backup your database to local file.",
"input_method": "stdin",
"parameters": {
"database": {
"description": "Database to connect to",
"type": "Optional[String[1]]"
},
"user": {
"description": "The user",
"type": "Optional[String[1]]"
},
"password": {
"description": "The password",
"type": "Optional[String[1]]"
},
"file": {
"description": "Path to file you want backup to",
"type": "String[1]"
}
}here's sample markdown output: TasksexportAllows you to backup your database to local file. Supports noop? false Parameters
|
|
This looks great! +100 |
Currently, puppet-strings does not know how to generate documentation for Puppet Tasks. This does all the work to add support for Tasks including a new JSON parser, a task handler, task statement, and task code object. Basically, Strings reads the JSON using the native ruby json parser and sends values through in a way it understands. It is only passing json key/value pairs through, nothing is happening with tags at this time. You can now document Tasks and generate HTML, Markdown, or JSON output.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.