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 1 #63056

Merged
merged 35 commits into from
Oct 8, 2019
Merged

Conversation

acozine
Copy link
Contributor

@acozine acozine commented Oct 2, 2019

SUMMARY

Edits several of the User Guide pages. This represents probably 1/4 to 1/3 of the work I have in mind for the User Guide.

Main changes include:

  • major edits to the Patterns, Getting Started and Inventory pages
  • minor edits to several other pages
  • new page focusing on logging
  • new page focusing on connections
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs.ansible.com

@goneri goneri added the ci_verified Changes made in this PR are causing tests to fail. label Oct 2, 2019
@ansibot
Copy link
Contributor

ansibot commented Oct 2, 2019

The test ansible-test sanity --test docs-build [explain] failed with 10 errors:

docs/docsite/rst/index.rst:88:0: literal-block-lex-error: Could not lex literal_block as "YAML+Jinja". Highlighting skipped.
docs/docsite/rst/reference_appendices/faq.rst:210:0: undefined-label: undefined label: working_with_bsd (if the link has no caption the label must precede a section header)
docs/docsite/rst/user_guide/basic_concepts.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/user_guide/connection_details.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/user_guide/connection_details.rst:49:0: duplicate-label: duplicate label host_key_checking, other instance in /root/ansible/docs/docsite/rst/reference_appendices/config.rst
docs/docsite/rst/user_guide/intro_adhoc.rst:19:0: undefined-label: undefined label: _intro_patterns (if the link has no caption the label must precede a section header)
docs/docsite/rst/user_guide/intro_adhoc.rst:74:0: undefined-label: undefined label: template <template_module (if the link has no caption the label must precede a section header)
docs/docsite/rst/user_guide/intro_adhoc.rst:76:0: undefined-label: undefined label: file <file_module (if the link has no caption the label must precede a section header)
docs/docsite/rst/user_guide/intro_getting_started.rst:13:0: undefined-label: undefined label: intro_playbooks (if the link has no caption the label must precede a section header)
docs/docsite/rst/user_guide/logging.rst:0:0: not-in-toc-tree: document isn't included in any toctree

click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Oct 2, 2019

@ansibot ansibot added WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. affects_2.10 This issue/PR affects Ansible v2.10 bsd BSD community docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. needs_triage Needs a first human triage before being processed. networking Network category support:core This issue/PR relates to code supported by the Ansible Engineering Team. and removed needs_triage Needs a first human triage before being processed. ci_verified Changes made in this PR are causing tests to fail. labels Oct 2, 2019
@samccann
Copy link
Contributor

samccann commented Oct 2, 2019

Did some analytics and the BSD guide gets negligable hits (0.2% overall). The windows guide gets more (roughly 7%). Can we move them both out to Common Ansible Scenarios section?

docs/docsite/rst/reference_appendices/logging.rst Outdated Show resolved Hide resolved
docs/docsite/rst/reference_appendices/logging.rst Outdated Show resolved Hide resolved
This is a good place to start to understand the basics of what Ansible can do
prior to learning the playbooks language -- ad-hoc commands can also be used
to do quick things that you might not necessarily want to write a full playbook for.
$ ansible [pattern] -m [module] -a "[module options]"
Copy link
Contributor

Choose a reason for hiding this comment

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

code-block please

docs/docsite/rst/user_guide/intro_adhoc.rst Show resolved Hide resolved
docs/docsite/rst/user_guide/intro_inventory.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/intro_inventory.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/intro_inventory.rst Outdated Show resolved Hide resolved
docs/docsite/rst/user_guide/playbooks_async.rst Outdated Show resolved Hide resolved
@samccann samccann changed the title [WIP] Docs: User guide overhaul, part 1 Docs: User guide overhaul, part 1 Oct 8, 2019
@samccann samccann removed the WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. label Oct 8, 2019
@samccann samccann merged commit 941a9b6 into ansible:devel Oct 8, 2019
acozine added a commit to acozine/ansible that referenced this pull request Oct 8, 2019
@acozine acozine mentioned this pull request Oct 8, 2019
acozine added a commit that referenced this pull request Oct 9, 2019
* Fixing typo mistake in testbed with section. Deploy template from content library is supported from 67U3

(cherry picked from commit c6c13b5)

* Typo fix in mssql_db (#63184)
Changed from 'then' to 'than'

(cherry picked from commit b5cc087)

* VMware: Update maintenance notes on vmware_cfg_backup (#62853)
Maintenance mode seems only to be required for load or restet, not for save_configuration. 

(cherry picked from commit e977e0a)

* Misc typo in nxos_config documentation (#62629)
* Changed 'exit' to 'exist'
* Removed unnecessary word 'first'

(cherry picked from commit 0554b50)

* postgresql: add elements for list params to the module's documentation (#63186)

(cherry picked from commit 8a37a24)

* mysql: add elements for list params to the modules' documentation (#63187)

(cherry picked from commit 30c2d21)

* Add spaces around {{ indicators. (#63125)
The example looked a little less readable by not having spaces after `{{` and before `}}`. This commit should make the examples match [ansible-lint rule 206](https://github.com/ansible/ansible-lint/blob/master/lib/ansiblelint/rules/VariableHasSpacesRule.py)

(cherry picked from commit b7a9d99)

* fix typo in collection/plugins/readme (#63162)

(cherry picked from commit da1a945)

*  Docs: User guide overhaul, part 1 (#63056)

(cherry picked from commit 941a9b6)
@acozine acozine deleted the user_guide_overhaul branch October 14, 2019 19:29
@ansible ansible locked and limited conversation to collaborators Nov 13, 2019
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 bsd BSD community 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