mirror of
https://github.com/ansible/ansible-documentation.git
synced 2026-03-27 13:28:51 +07:00
c7c3eea9dc
* Add yamllint check for RST code listings. * Address review comments. * Sort languages and remove no longer needed duplicates. * Enable warnings, but disable all failing rules. * Improve formulation. Co-authored-by: Don Naro <dnaro@redhat.com> * Show allowed languages when no or invalid language is supplied. Improve line lengths. * Make sure that 'yamllint .' passes. * Fix indentation issues introduced in #2095. --------- Co-authored-by: Don Naro <dnaro@redhat.com>
37 lines
1.1 KiB
YAML
37 lines
1.1 KiB
YAML
---
|
|
# 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 https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html for more information
|
|
#
|
|
module: modulename
|
|
short_description: This is a short phrase describing the module
|
|
description:
|
|
- Longer description of the module.
|
|
- You might include instructions.
|
|
version_added: "X.Y"
|
|
author: "Your AWESOME name (@awesome-github-id)"
|
|
deprecated: "X.5"
|
|
options:
|
|
# One or more of the following
|
|
option_name:
|
|
description:
|
|
- Description of the options goes here.
|
|
- Must be written in sentences.
|
|
required: true or false
|
|
default: a string or the word null
|
|
choices:
|
|
- enable
|
|
- disable
|
|
aliases:
|
|
- repo_name
|
|
version_added: "1.X"
|
|
requirements:
|
|
- list of required things
|
|
- like the factor package
|
|
- zypper >= 1.0
|
|
seealso:
|
|
- specify references to other modules, useful guides, and so on
|
|
notes:
|
|
- other things consumers of your module should know
|