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

Swap ordering to ensure Dynamic always first #58998

Conversation

d-little
Copy link
Contributor

@d-little d-little commented Jul 11, 2019

SUMMARY

I found myself having trouble with this documentation during my own self-learning. The inconsistent order of references to dynamic/include vs. static/import caused me to keep scrolling back up to check if include was Dynamic or Static, and the same with 'which is import'.

This PR simply re-orders a few dotpoints and references to ensure that Dynamic/Include is always mentioned before Static/Import in a consistent manner. This should help to re-enforce which is which without scrolling throughout the page.

I chose Dynamic to be 'first' as the first paragraph refers to 'Dynamic vs. Static' with the footnote tagged as _dynamic_vs_static.

ISSUE TYPE

Docs Pull Request

COMPONENT NAME

playbooks_reuse.rst

@ansibot
Copy link
Contributor

ansibot commented Jul 11, 2019

@ansibot ansibot added affects_2.9 This issue/PR affects Ansible v2.9 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 Jul 11, 2019
@acozine
Copy link
Contributor

acozine commented Jul 12, 2019

This is a nice improvement @d-little, thanks. This page might do well re-organized as a table, with include_* and import_* as the columns and rows for the attributes, like dynamic/static, loops yes/no, etc. Meanwhile this change makes the page better than it was.

@acozine acozine merged commit 11d61cc into ansible:devel Jul 12, 2019
@mkrizek mkrizek removed needs_triage Needs a first human triage before being processed. labels Jul 15, 2019
@ansible ansible locked and limited conversation to collaborators Aug 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.9 This issue/PR affects Ansible v2.9 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants