From 9dae6979974ac10b1f035e9bdd779ec65c012cfa Mon Sep 17 00:00:00 2001 From: Dylan Silva Date: Wed, 15 Mar 2017 15:34:00 -0700 Subject: [PATCH] Updates to docs for metadata. (#22667) * Updates to docs for metadata. * Update developing_modules_documenting.rst --- .../dev_guide/developing_modules_documenting.rst | 14 ++++++-------- docs/docsite/rst/modules_support.rst | 3 +-- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst index f1c2dcc3b6..f8832196a2 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst @@ -82,14 +82,12 @@ Fields :supported_by: This field records who supports the module. Default value is ``community``. Values are: - :core: Maintained by the Ansible core team. Core team will fix - bugs, add new features, and review PRs. - :community: This module is maintained by the community at large, - which is responsible for fixing bugs, adding new features, and - reviewing changes. - :curated: The Ansible Core Team is the gatekeeper for this module. They - will review PRs from the community before merging but might not generate - fixes and code for new features on their own. + :core: + :curated: + :community: + + For information on what the support level values entail, please see + :doc:`../modules_support.rst` :status: This field records information about the module that is important to the end user. It’s a list of strings. The default value diff --git a/docs/docsite/rst/modules_support.rst b/docs/docsite/rst/modules_support.rst index dbf6c02cf6..4af32e6cbb 100644 --- a/docs/docsite/rst/modules_support.rst +++ b/docs/docsite/rst/modules_support.rst @@ -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. -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. These modules are currently shipped with Ansible, but might be shipped separately in the future.