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: Proposal: list playbook keywords with "Applies to" flags #69656

Draft
wants to merge 1 commit into
base: devel
Choose a base branch
from

Conversation

moreati
Copy link
Contributor

@moreati moreati commented May 21, 2020

SUMMARY

The playbook keywords reference is currently organised by category, then applicable keywords.

I propose reorganising this, to list all keywords at the top level, each with an "Applies to" block. The PR shows a demonstrator. It isn't intended to as a polished, styled final design.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

The motivations for this proposed reorganisation are

  • Make it easy to link to one canonical reference for a given keyword
  • Make it easier to see what categories/levels a given keyword applies to
  • Reduce repetition of keyword descriptions on the page

I hope the following table and screenshot illustrate the concept

Current organisation Proposed organisation

Play

any_errors_fatal
   [description]

become
   [description]

...

Role

any_errors_fatal
   [description]

become
   [description]

...

action

Applies to: ✗ Play ✗ Role ✗ Block ✓ Task

[description]

always

Applies to: ✗ Play ✗ Role ✓ Block ✗ Task

[description]

...

image

@ansibot ansibot added affects_2.10 This issue/PR affects Ansible v2.10 core_review In order to be merged, this PR must follow the core review workflow. 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 May 21, 2020
@bcoca bcoca removed the needs_triage Needs a first human triage before being processed. label May 26, 2020
@ansibot ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Jun 3, 2020
@acozine
Copy link
Contributor

acozine commented Jun 16, 2020

This is an interesting enhancement, thanks @moreati. We are in the midst of changing our docs pipeline to work with collections, so it may take us some time to get to this.

Copy link
Member

@bcoca bcoca left a comment

Choose a reason for hiding this comment

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

some people prefer to look at it by the object, I would prefer to not replace the existing page but compliment it and have each link to each other.

@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Jun 17, 2020
@moreati
Copy link
Contributor Author

moreati commented Jun 17, 2020

compliment it and have each link to each other

I'll iterate the prototype on that basis

@moreati moreati marked this pull request as draft June 23, 2020 23:12
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jun 23, 2020
@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. pre_azp This PR was last tested before migration to Azure Pipelines. and removed core_review In order to be merged, this PR must follow the core review workflow. stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. labels Dec 9, 2020
@ansibot ansibot added the WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. label Feb 16, 2021
@ansibot ansibot added the needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html label Mar 2, 2022
@ansibot ansibot added needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html and removed needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affects_2.10 This issue/PR affects Ansible v2.10 docs This issue/PR relates to or includes documentation. needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. pre_azp This PR was last tested before migration to Azure Pipelines. support:core This issue/PR relates to code supported by the Ansible Engineering Team. WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants