mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-08 14:22:46 +00:00
Standardized on yml suffix, so fix this example content filename.
This commit is contained in:
29
examples/DOCUMENTATION.yml
Normal file
29
examples/DOCUMENTATION.yml
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
# 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.
|
||||
module: modulename
|
||||
short_description: This is a sentence describing the module
|
||||
description:
|
||||
- Longer description of the module
|
||||
- You might include instructions
|
||||
version_added: "X.Y"
|
||||
author: Your AWESOME name here
|
||||
notes:
|
||||
- Other things consumers of your module should know
|
||||
requirements:
|
||||
- list of required things
|
||||
- like the factor package
|
||||
- or a specic platform
|
||||
options:
|
||||
# One or more of the following
|
||||
option_name:
|
||||
description:
|
||||
- Words go here
|
||||
- that describe
|
||||
- this option
|
||||
required: true or false
|
||||
default: a string or the word null
|
||||
choices: [list, of, choices]
|
||||
aliases: [list, of, aliases]
|
||||
version_added: 1.X
|
||||
Reference in New Issue
Block a user