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
Conversation
This comment has been minimized.
This comment has been minimized.
The test
|
There was a problem hiding this 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...
@acozine This PR was evaluated as a potentially problematic PR for the following reasons:
Such PR can only be merged by human. Contact a Core team member to review this PR on IRC: |
082dea4
to
9cf2230
Compare
There was a problem hiding this 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.
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!). |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
Commit gundalow's review comments. Co-Authored-By: John R Barker <john@johnrbarker.com>
The test
The test
|
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:
- Removes the old Best Practices pageISSUE TYPE
COMPONENT NAME
docs.ansible.com
user_guide