docs: Proposal: list playbook keywords with "Applies to" flags

[moreati]

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] ...

[acozine]

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.

[bcoca]

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.

[moreati]

compliment it and have each link to each other

I'll iterate the prototype on that basis

[moreati]

I didn't iterate, and now the docs have moved to https://github.com/ansible/ansible-documentation/. As a rough and ready one off, I've generated a table https://gist.github.com/moreati/d7cb1573e8f00dd320d6569bb35b5f61. I may revisit this in a new PR to the migrated repo.