mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Misc docs fixes
* Revise and link inline to the lists of modules * Fix jinja2 objects.inv fallback path * Fix bolding of deprecation marker * Change module_support to link to lists via :doc: That links to the top of the page instead of a section. * Add a short text for each list of maintained modules * Change maintenance info to only display on core and network modules
This commit is contained in:
Toshio Kuratomi
parent
84ea2af4b6
commit
40ea448c7b
6 changed files with 54 additions and 35 deletions
|
|
@ -409,16 +409,45 @@ def process_categories(mod_info, categories, templates, output_dir, output_name)
|
|||
def process_support_levels(mod_info, templates, output_dir):
|
||||
supported_by = {'Ansible Core Team': {'slug': 'core_supported',
|
||||
'modules': [],
|
||||
'output': 'core_maintained.rst'},
|
||||
'output': 'core_maintained.rst',
|
||||
'blurb': "These are :doc:`modules maintained by the"
|
||||
" Ansible Core Team<core_maintained>` and will always ship"
|
||||
" with Ansible itself."},
|
||||
'Ansible Network Team': {'slug': 'network_supported',
|
||||
'modules': [],
|
||||
'output': 'network_maintained.rst'},
|
||||
'output': 'network_maintained.rst',
|
||||
'blurb': "These are :doc:`modules maintained by the"
|
||||
" Ansible Network Team<network_maintained>` in"
|
||||
" a relationship similar to how the Ansible Core Team"
|
||||
" maintains the Core modules."},
|
||||
'Ansible Partners': {'slug': 'partner_supported',
|
||||
'modules': [],
|
||||
'output': 'partner_maintained.rst'},
|
||||
'output': 'partner_maintained.rst',
|
||||
'blurb': """
|
||||
Some examples of :doc:`Certified Modules<partner_maintained>` are those submitted by other
|
||||
companies. Maintainers of these types of modules must watch for any issues reported or pull requests
|
||||
raised against the module.
|
||||
|
||||
The Ansible Core Team will review all modules becoming certified. Core committers will review
|
||||
proposed changes to existing Certified 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.
|
||||
"""},
|
||||
'Ansible Community': {'slug': 'community_supported',
|
||||
'modules': [],
|
||||
'output': 'community_maintained.rst'},
|
||||
'output': 'community_maintained.rst',
|
||||
'blurb': """
|
||||
These are :doc:`modules maintained by the Ansible Community<community_maintained>`. They **are
|
||||
not** supported by the Ansible Core Team or by companies/partners associated to the module.
|
||||
|
||||
They are still fully usable, but the response rate to issues is purely up to the community. Best
|
||||
effort support will be provided but is not covered under any support contracts.
|
||||
|
||||
These modules are currently shipped with Ansible, but will most likely be shipped separately in the future.
|
||||
"""},
|
||||
}
|
||||
|
||||
# Separate the modules by support_level
|
||||
|
|
|
|||
|
|
@ -225,6 +225,6 @@ latex_documents = [
|
|||
|
||||
autoclass_content = 'both'
|
||||
|
||||
intersphinx_mapping = {'python': ('https://docs.python.org/2', (None, '../python2-2.7.13.inv')),
|
||||
'python3': ('https://docs.python.org/3', (None, '../python3-3.6.2.inv')),
|
||||
'jinja2': ('http://jinja.pocoo.org/docs', (None, 'jinja2-2.9.7.inv'))}
|
||||
intersphinx_mapping = {'python': ('https://docs.python.org/2/', (None, '../python2-2.7.13.inv')),
|
||||
'python3': ('https://docs.python.org/3/', (None, '../python3-3.6.2.inv')),
|
||||
'jinja2': ('http://jinja.pocoo.org/docs/', (None, '../jinja2-2.9.7.inv'))}
|
||||
|
|
|
|||
|
|
@ -18,46 +18,34 @@ The modules are hosted on GitHub in a subdirectory of the `ansible <https://gith
|
|||
Core
|
||||
````
|
||||
|
||||
These are modules that the Ansible Core Team maintains and will always ship with Ansible itself.
|
||||
They will also receive slightly higher priority for all requests. Non-core modules are still fully usable.
|
||||
|
||||
.. seealso::
|
||||
List of :ref:`Core Supported<core_supported>` modules
|
||||
These are :doc:`modules maintained by the Ansible Core Team<core_maintained>`
|
||||
and will always ship with Ansible itself.
|
||||
|
||||
Network
|
||||
```````
|
||||
|
||||
These modules are supported by the Ansible Network Team in a relationship
|
||||
These are :doc:`modules maintained by the Ansible Network Team<network_maintained>` in a relationship
|
||||
similar to how the Ansible Core Team maintains the Core modules.
|
||||
|
||||
.. seealso::
|
||||
List of :ref:`Network Supported<network_supported>` modules
|
||||
|
||||
Certified
|
||||
`````````
|
||||
|
||||
Some examples of Certified modules are those submitted by other companies. Maintainers of these types of modules must watch for any issues reported or pull requests raised against the module.
|
||||
Some examples of :doc:`Certified Modules<partner_maintained>` are those submitted by other companies. 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 Certified. Core Committers will review proposed changes to existing Certified 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.
|
||||
The Ansible Core Team will review all modules becoming certified. Core committers will review proposed changes to existing Certified 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.
|
||||
|
||||
.. seealso::
|
||||
List of :ref:`Certified<partner_supported>` modules
|
||||
|
||||
Community
|
||||
`````````
|
||||
These modules **are not** supported by Core Committers or by companies/partners associated to the module. They are maintained by the community.
|
||||
|
||||
These are :doc:`modules maintained by the Ansible Community<community_maintained>`. They **are not** supported by the Ansible Core Team or by companies/partners associated to the module.
|
||||
|
||||
They are still fully usable, but the response rate to issues is purely up to the community. Best effort support will be provided but is not covered under any support contracts.
|
||||
|
||||
These modules are currently shipped with Ansible, but will most likely be shipped separately in the future.
|
||||
|
||||
.. seealso::
|
||||
List of Core Supported modules
|
||||
List of :ref:`Community Supported<community_supported>` modules
|
||||
|
||||
|
||||
.. seealso::
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
@{ title }@ Modules
|
||||
@{ '`' * title | length }@````````
|
||||
|
||||
{% if blurb %}
|
||||
@{ blurb }@
|
||||
|
||||
{% endif %}
|
||||
.. toctree:: :maxdepth: 1
|
||||
{% if category['_modules'] %}
|
||||
|
||||
|
|
@ -16,7 +20,7 @@
|
|||
.. toctree:: :maxdepth: 1
|
||||
|
||||
{% for module in info['_modules'] | sort %}
|
||||
@{ module }@{% if module_info[module]['deprecated'] %}**(D)**{% endif%} - @{ module_info[module]['doc']['short_description'] }@ <@{ module }@_module>
|
||||
@{ module }@{% if module_info[module]['deprecated'] %} **(D)**{% endif%} - @{ module_info[module]['doc']['short_description'] }@ <@{ module }@_module>
|
||||
{% endfor %}
|
||||
|
||||
{% endfor %}
|
||||
|
|
|
|||
2
docs/templates/modules_by_support.rst.j2
vendored
2
docs/templates/modules_by_support.rst.j2
vendored
|
|
@ -6,7 +6,7 @@ Modules Maintained by the @{ maintainers }@
|
|||
.. toctree:: :maxdepth: 1
|
||||
|
||||
{% for module in modules | sort %}
|
||||
@{ module }@{% if module_info[module]['deprecated'] %}**(D)**{% endif %} - @{ module_info[module]['doc']['short_description'] }@ <@{ module }@_module>
|
||||
@{ module }@{% if module_info[module]['deprecated'] %} **(D)**{% endif %} - @{ module_info[module]['doc']['short_description'] }@ <@{ module }@_module>
|
||||
{% endfor %}
|
||||
|
||||
.. note::
|
||||
|
|
|
|||
12
docs/templates/plugin.rst.j2
vendored
12
docs/templates/plugin.rst.j2
vendored
|
|
@ -279,15 +279,13 @@ Status
|
|||
This module is flagged as **@{cur_state}@** which means that @{module_states[cur_state]}@.
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% if metadata.supported_by in ('core', 'network') %}
|
||||
|
||||
{% if metadata.supported_by %}
|
||||
Maintenance Info
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Support Level
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
This module is maintained by @{ support[metadata.supported_by] }@
|
||||
|
||||
For more information on what this means please read :doc:`modules_support`.
|
||||
For more information about Red Hat's this support of this module, please
|
||||
refer to this `knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>`
|
||||
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
|
|
|||
Loading…
Reference in a new issue