cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Updates to docs for metadata. (#22667)

Browse source 
* Updates to docs for metadata.

* Update developing_modules_documenting.rst
This commit is contained in:
Dylan Silva 2017-03-15 15:34:00 -07:00 committed by GitHub
parent 0c44959800
commit 9dae697997
2 changed files with 7 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/docsite/rst/dev_guide/developing_modules_documenting.rst
View file

@ -82,14 +82,12 @@ Fields
:supported_by: This field records who supports the module. :supported_by: This field records who supports the module.
Default value is ``community``. Values are: Default value is ``community``. Values are:
:core: Maintained by the Ansible core team. Core team will fix :core:
bugs, add new features, and review PRs. :curated:
:community: This module is maintained by the community at large, :community:
which is responsible for fixing bugs, adding new features, and
reviewing changes. For information on what the support level values entail, please see
:curated: The Ansible Core Team is the gatekeeper for this module. They :doc:`../modules_support.rst`
will review PRs from the community before merging but might not generate
fixes and code for new features on their own.
:status: This field records information about the module that is :status: This field records information about the module that is
important to the end user. It’s a list of strings. The default value important to the end user. It’s a list of strings. The default value

3
docs/docsite/rst/modules_support.rst
View file

@ -26,8 +26,7 @@ Curated
Some examples of Curated modules are submitted by other companies or maintained by the community. Maintainers of these types of modules must watch for any issues reported or pull requests raised against the module. Some examples of Curated modules are submitted by other companies or maintained by the community. Maintainers of these types of modules must watch for any issues reported or pull requests raised against the module.
Core Committers will review all modules becoming Curated or updates to existing Curated modules. Core committers will also ensure that any issues that arise due to Ansible engine changes will be remediated. Core Committers will review all modules becoming Curated. Core Committers will review proposed changes to existing Curated modules once the community maintainers of the module have approved the changes. Core committers will also ensure that any issues that arise due to Ansible engine changes will be remediated.
Also, it is strongly recommended (but not presently required) for these types of modules to have unit tests. Also, it is strongly recommended (but not presently required) for these types of modules to have unit tests.
These modules are currently shipped with Ansible, but might be shipped separately in the future. These modules are currently shipped with Ansible, but might be shipped separately in the future.