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: User Guide overhaul, part 3 #66371

Merged
merged 8 commits into from
Jan 21, 2020
Merged

Conversation

acozine
Copy link
Contributor

@acozine acozine commented Jan 10, 2020

SUMMARY

Related to #65474 and #63056.

Edits more User Guide pages. Main goals include de-duplicating content, organizing content around user goals, helping users find the content they need by providing action-oriented headers, and slimming down the text where possible.

Main changes include:

  • major edits to the Tags, Roles, and Re-use pages
  • consolidating playbooks_reuse and playbooks_reuse_includes into one page
  • creating a table comparing Imports and Includes
  • minor edits to the Python versions page
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs.ansible.com
User Guide, Tags, Roles, Includes, Imports

@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. 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. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Jan 10, 2020
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed 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. labels Jan 13, 2020
@acozine acozine removed the needs_triage Needs a first human triage before being processed. label Jan 13, 2020
Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

some nits


Ansible offers two ways to re-use files and roles in a playbook: dynamic and static.

- For dynamic re-use, add an ``include_*`` task in the tasks section of a play:
Copy link
Contributor

Choose a reason for hiding this comment

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

is it still an include_* task if you are including a role or vars? same question for the import_* below this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I haven't figured out how to express this yet. Any time you use include_*, that line is, itself, a task. So it's not about what you're including, it's about where/how you're including.

Copy link

@danmacpherson danmacpherson left a comment

Choose a reason for hiding this comment

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

Hi Alicia, add my feedback, which was mostly style-related. I did spot an issue with one of the CLI options (-tags instead of --tags), but overall it reads well and I understood what your wrote quite clearly.

docs/docsite/rst/user_guide/playbooks_python_version.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_python_version.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_python_version.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_reuse.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_reuse.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_tags.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_tags.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_tags.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_tags.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_tags.rst Outdated Show resolved Hide resolved
@acozine
Copy link
Contributor Author

acozine commented Jan 21, 2020

Thanks @samccann @cbudz and @danmacpherson for the detailed reviews! I think I've incorporated all your comments.

@samccann samccann merged commit 0b503f6 into ansible:devel Jan 21, 2020
NehaKembalkarA10 pushed a commit to NehaKembalkarA10/ansible that referenced this pull request Jan 30, 2020
@ansible ansible locked and limited conversation to collaborators Feb 19, 2020
@acozine acozine deleted the user_guide_reuse branch March 3, 2020 18:25
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
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. has_issue 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.

5 participants