diff options
| author | John R Barker <john@johnrbarker.com> | 2017-02-10 12:15:55 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-02-10 12:15:55 +0000 |
| commit | 959637ff59681250fe62c8e0cc7d81989cdc13f5 (patch) | |
| tree | 62a914af4d1d822f8e7257bc48402d697bcfcbcc /examples/DOCUMENTATION.yml | |
| parent | 2ccedc2ed94dc69191b52c39bf608b0c4b6241ae (diff) | |
| download | ansible-959637ff59681250fe62c8e0cc7d81989cdc13f5.tar.gz | |
How to document your module (#21021)
* How to document your module
* Remove blank lines
* note:: Versions should be strings
* requirements on the host that executes the module.
* option names & option values
* Feedback
* formatting
* Scott's final feedback
Diffstat (limited to 'examples/DOCUMENTATION.yml')
| -rw-r--r-- | examples/DOCUMENTATION.yml | 36 |
1 files changed, 20 insertions, 16 deletions
diff --git a/examples/DOCUMENTATION.yml b/examples/DOCUMENTATION.yml index 86f9c9462f..f3b64c21d3 100644 --- a/examples/DOCUMENTATION.yml +++ b/examples/DOCUMENTATION.yml @@ -2,29 +2,33 @@ # If a key doesn't apply to your module (ex: choices, default, or # aliases) you can use the word 'null', or an empty list, [], where # appropriate. +# +# See docs.ansible.com/ansible/dev_guide/developing_modules.html for more information +# module: modulename short_description: This is a sentence describing the module description: - - Longer description of the module - - You might include instructions + - Longer description of the module. + - You might include instructions. version_added: "X.Y" -author: "Your AWESOME name, @awesome-github-id" -notes: - - Other things consumers of your module should know - - Additional setting requirements -requirements: - - list of required things - - like the factor package - - or a specific platform +author: "Your AWESOME name (@awesome-github-id)" options: # One or more of the following option_name: description: - - Words go here - - that describe - - this option + - Description of the options goes here. + - Must be written in sentences. required: true or false default: a string or the word null - choices: [list, of, choices] - aliases: [list, of, aliases] - version_added: 1.X + choices: + - enable + - disable + aliases: + - repo_name + version_added: "1.X" +notes: + - Other things consumers of your module should know. +requirements: + - list of required things. + - like the factor package + - zypper >= 1.0 |