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.

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

docs: add Support section for plugin types #46520

Merged
merged 3 commits into from
Oct 8, 2018

Conversation

jborean93
Copy link
Contributor

@jborean93 jborean93 commented Oct 5, 2018

SUMMARY

Always show the Support section for plugins that contains supported_by in the metadata. Currently this will only be displayed when the plugin is core or network supported and even in those cases it doesn't explicitly say what they are, just links to a Red Hat document.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs

ANSIBLE VERSION
devel
ADDITIONAL INFORMATION

Here's an example of a core module before

image

And after the changes

image

Here's an example of a community module before

image

And after the changes

image

@jborean93 jborean93 requested a review from acozine October 5, 2018 01:21
@ansibot
Copy link
Contributor

ansibot commented Oct 5, 2018

@ansibot ansibot added affects_2.8 This issue/PR affects Ansible v2.8 docs This issue/PR relates to or includes documentation. needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Oct 5, 2018
@acozine
Copy link
Contributor

acozine commented Oct 5, 2018

@jborean93 thanks for putting this together. The use of "support" here might confuse customers - how about two headings, one for "Maintenance" that covers the core/partner/community metadata, and a separate one for "Red Hat Support" or "Customer Support" for the link to the KB article? @michelleperz do we have standard terminology?

@ansibot ansibot removed the needs_triage Needs a first human triage before being processed. label Oct 5, 2018
@jborean93
Copy link
Contributor Author

@acozine no worries, so basically Maintenance will always be there and cover the metadata and leave Support as it is in the docs right now.

@jborean93
Copy link
Contributor Author

I've just pushed the changes, here is the output of a core module now

image

The other module types are also the same but don't have the Support section just like before.

@acozine
Copy link
Contributor

acozine commented Oct 8, 2018

Thanks @jborean93!

Copy link
Contributor

@acozine acozine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks @jborean93.

@acozine acozine merged commit 1599752 into ansible:devel Oct 8, 2018
@acozine acozine added this to To do in OLD Ansible Documentation via automation Oct 8, 2018
@jborean93 jborean93 deleted the docs-supports branch October 8, 2018 19:44
jborean93 added a commit to jborean93/ansible that referenced this pull request Oct 8, 2018
* docs: add Maintenance section for plugin types
* Added supported_by name in bold to match Status

(cherry picked from commit 1599752)
jborean93 added a commit to jborean93/ansible that referenced this pull request Oct 8, 2018
* docs: add Maintenance section for plugin types
* Added supported_by name in bold to match Status

(cherry picked from commit 1599752)
@jborean93
Copy link
Contributor Author

Thanks @acozine

Backport PRs
stable-2.6 #46644
stable-2.7 #46643

acozine pushed a commit that referenced this pull request Oct 8, 2018
* docs: add Maintenance section for plugin types
* Added supported_by name in bold to match Status

(cherry picked from commit 1599752)
acozine pushed a commit that referenced this pull request Oct 8, 2018
* docs: add Maintenance section for plugin types
* Added supported_by name in bold to match Status

(cherry picked from commit 1599752)
@acozine acozine moved this from To do to Done in OLD Ansible Documentation Nov 8, 2018
@ansible ansible locked and limited conversation to collaborators Jul 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.8 This issue/PR affects Ansible v2.8 docs This issue/PR relates to or includes documentation. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants