Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add Support section for plugin types #46520

Merged
merged 3 commits into from
Oct 8, 2018
Merged

docs: add Support section for plugin types #46520

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
acdd9aa
docs: add Support section for plugin types
jborean93 Oct 5, 2018
1992529
Added supported_by name in bold to match Status
jborean93 Oct 5, 2018
cf4026b
moved supported_by to Maintenance section
jborean93 Oct 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 15 additions & 2 deletions docs/templates/plugin.rst.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ Status
------
{% if not deprecated %}

{% set support = { 'core': 'The Ansible Core Team', 'network': 'The Ansible Network Team', 'certified': 'an Ansible Partner', 'community': 'The Ansible Community', 'curated': 'A Third Party'} %}
{% set support = { 'core': 'the Ansible Core Team', 'network': 'the Ansible Network Team', 'certified': 'an Ansible Partner', 'community': 'the Ansible Community', 'curated': 'a Third Party'} %}
{% set module_states = { 'preview': 'it is not guaranteed to have a backwards compatible interface', 'stableinterface': 'the maintainers for this module guarantee that no backward incompatible interface changes will be made'} %}

{% if metadata %}
Expand All @@ -396,12 +396,25 @@ This @{ plugin_type }@ is flagged as **@{cur_state}@** which means that @{module

{% endif %}

{% if metadata.supported_by in ('core', 'network') %}
{% if metadata.supported_by %}

Maintenance
-----------

{% set supported_by = support[metadata.supported_by] %}
This @{ plugin_type }@ is flagged as **@{metadata.supported_by}@** which means that it is maintained by @{ supported_by }@. See :ref:`Module Maintenance & Support <modules_support>` for more info.

For a list of other modules that are also maintained by @{ supported_by }@, see :ref:`here <@{ metadata.supported_by }@_supported>`.

{% if metadata.supported_by in ('core', 'network') %}

Support
~~~~~~~

For more information about Red Hat's support of this @{ plugin_type }@,
please refer to this `Knowledge Base article <https://access.redhat.com/articles/rhel-top-support-policies/>`_
{% endif %}

{% endif %}

{% endif %}
Expand Down