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 2 #65474

Merged
merged 18 commits into from Dec 12, 2019
Merged

Conversation

acozine
Copy link
Contributor

@acozine acozine commented Dec 3, 2019

SUMMARY

Related to #63056.

Edits more User Guide pages. Main goals include reducing duplication of content, 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 Filters, Async, Blocks, Error Handling, and Intro to Playbooks pages
  • Creates a Sample Setup page from the content about organizing your Ansible artifacts on the old Best Practices page
  • Creates a Tips and Tricks page out of the remaining content from the old Best Practices page, retaining the file name to avoid redirects
    - Removes the old Best Practices page
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs.ansible.com
user_guide

@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 Dec 3, 2019
@ansibot

This comment has been minimized.

@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 Dec 3, 2019
@ansibot
Copy link
Contributor

ansibot commented Dec 3, 2019

The test ansible-test sanity --test docs-build [explain] failed with 1 error:

docs/docsite/rst/network/getting_started/network_connection_options.rst:13:0: undefined-label: undefined label: playbook_hosts_and_users (if the link has no caption the label must precede a section header)

click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Dec 3, 2019

@ansibot ansibot added docsite This issue/PR relates to the documentation website. networking Network category 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 Dec 3, 2019
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.

Ran it through a spellchecker so there are a few real nit suggestions for things like Boolean, and YAML etc...

docs/docsite/rst/user_guide/playbooks_advanced_syntax.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_advanced_syntax.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_async.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_async.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_filters.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_filters.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_filters.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_filters.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_intro.rst Outdated Show resolved Hide resolved
@ansibot ansibot removed the needs_triage Needs a first human triage before being processed. label Dec 4, 2019
@ansibot
Copy link
Contributor

ansibot commented Dec 4, 2019

@acozine This PR was evaluated as a potentially problematic PR for the following reasons:

  • More than 50 commits.

Such PR can only be merged by human. Contact a Core team member to review this PR on IRC: #ansible-devel on irc.freenode.net

click here for bot help

@ansibot ansibot added 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. core_review In order to be merged, this PR must follow the core review workflow. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Dec 4, 2019
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed core_review In order to be merged, this PR must follow the core review workflow. 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 Dec 4, 2019
Copy link
Contributor

@gundalow gundalow left a comment

Choose a reason for hiding this comment

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

Brilliant work, I know a lot of effort has gone into this.

docs/docsite/rst/user_guide/become.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/connection_details.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_advanced_syntax.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_async.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_blocks.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_templating.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_templating.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_templating.rst Outdated Show resolved Hide resolved
Sample Ansible setup
********************

You have learned about playbooks, inventory, roles, and variables. This section pulls all those elements together, outlining a sample setup for automating a web service. You can find more example playbooks illustrating these patterns in our `ansible-examples repository <https://github.com/ansible/ansible-examples>`_. (NOTE: These may not use all of the features in the latest release, but are still an excellent reference!).
Copy link
Contributor

Choose a reason for hiding this comment

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

Assuming this is page zero, which pages are we assuming they've already read?

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'm not entirely sure at this stage. The last step in the User Guide rewrite will be revamping all the various TOCs within it. I'd prefer to treat every page as Page Zero, because most users will come from search engine results, but also offer a reasonable "Zero to Sixty for Ansible Engine" tutorial if you follow the TOC.

docs/docsite/rst/user_guide/sample_setup.rst Outdated Show resolved Hide resolved
Commit gundalow's review comments.

Co-Authored-By: John R Barker <john@johnrbarker.com>
@ansibot
Copy link
Contributor

ansibot commented Dec 10, 2019

The test ansible-test sanity --test docs-build [explain] failed with 1 error:

docs/docsite/rst/user_guide/playbooks_filters.rst:592:0: block-quote-missing-blank-line: Block quote ends without a blank line; unexpected unindent.

The test ansible-test sanity --test rstcheck [explain] failed with 1 error:

docs/docsite/rst/user_guide/playbooks_filters.rst:592:0: Block quote ends without a blank line; unexpected unindent.

click here for bot help

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. 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 Dec 10, 2019
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Dec 12, 2019
@samccann samccann merged commit 860cacc into ansible:devel Dec 12, 2019
@acozine acozine deleted the user_guide_playbooks branch December 12, 2019 21:34
@ansible ansible locked and limited conversation to collaborators Jan 13, 2020
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. docsite This issue/PR relates to the documentation website. networking Network category 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