ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-22 21:00:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

many doc fixes

Browse source 
removed a bunch of warnings
made nicer formatting of new module info
This commit is contained in:
Brian Coca 2016-12-22 12:26:28 -05:00
commit 0f4ca877ac
12 changed files with 46 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

42
hacking/templates/rst.j2
View file

@ -169,26 +169,36 @@ Notes
{% endif %}
{% if not deprecated %}
Module Status: @{ ','.join(metadata.status) }@
--------------------
{% set support = { 'core': 'This module is maintained by those with core commit privileges', 'committer': 'This module is supported mainly by the community and is curated by core committers', 'community': 'This module is community maintained without core committer oversight'} %}
{% set module_states = { 'preview': 'it is not guaranteed to have a backwards compatible interface', 'stableinterface': 'the maintainers for this module guarantee that the no backward incompatible interface changes will be made'} %}
{% if metadata.supported_by == 'core' %}
{% if metadata %}
{% if metadata.status %}
This is a Core Module
---------------------
Status
~~~~~~
For more information on what this means please read :doc:`modules_core`
{% else %}
This module is supported by: @{ metadata.supported_by }@
------------------------
For more information on what this means please read :doc:`modules_extra`
{% endif %}
{% for cur_state in metadata.status %}
This module is flagged as **@{cur_state}@** which means that @{module_states[cur_state]}@.
{% endfor %}
{% endif %}
For help in developing on modules, should you be so inclined, please read :doc:`community`, :doc:`developing_test_pr` and :doc:`developing_modules`.
{% if metadata.supported_by %}
Support
~~~~~~~
@{ support[metadata.supported_by] }@
{% if metadata.supported_by == 'core' %}
For more information on what this means please read :doc:`modules_core`
{% else %}
For more information on what this means please read :doc:`modules_extra`
{% endif %}
{% endif %}
{% endif %}
{% endif %}
For help in developing on modules, should you be so inclined, please read :doc:`community`, :doc:`dev_guide/developing_test_pr` and :doc:`developing_modules`.