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 core_review docs needs_triage support:core labels May 21, 2020
@bcoca bcoca removed the needs_triage label May 26, 2020
@ansibot ansibot added the stale_ci label Jun 3, 2020
@acozine
Copy link
Contributor

@acozine 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

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 and removed core_review labels Jun 17, 2020
@moreati
Copy link
Contributor Author

@moreati 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 Jun 23, 2020
@ansibot ansibot added core_review and removed needs_revision labels Jun 23, 2020
@ansibot ansibot added needs_revision pre_azp and removed core_review stale_ci labels Dec 9, 2020
@ansibot ansibot added the WIP label Feb 16, 2021
@ansibot ansibot added the needs_rebase label Mar 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affects_2.10 docs needs_rebase needs_revision pre_azp support:core WIP
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants