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

Backport/2.8/docs rst omnibus #56310

Merged
merged 20 commits into from May 13, 2019

Conversation

acozine
Copy link
Contributor

@acozine acozine commented May 10, 2019

SUMMARY

Backports numerous changes to the rST documentation. We'll open a separate backport for changes to the module docs (any .py files).

Includes PRs:
#55535
#55111
#55674
#55680
#54929
#55783
#55784
#55795
#55941
#55931
#55568
#52008
#55747
#56007
#50205
#56183
#55796
#53273
#56283
#56306

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs.ansible.com

spellis and others added 20 commits May 10, 2019 11:26
Wrong protocol and port in command.

+label: docsite_pr

(cherry picked from commit 6ea3eca)
updates docs/docsite/rst/user_guide/vault.rst
* Add reference to single variable vault encryption
* rST ref to jump to the section
* Clarify the two targets of vault encryption, with notes about advantages and drawbacks of each
* Add the default form for --vault-id
* Add Vault ID examples for normal operations

Co-Authored-By: tacatac <taca@kadisius.eu>
(cherry picked from commit 79198ca)
There were a series of sections with subheadings in the loop
documentation, but the most recent additions did not follow the same
pattern.

(cherry picked from commit a5cb47d)
* Add microsoft document for memory hotfix

* Update docs/docsite/rst/user_guide/windows_setup.rst

Co-Authored-By: hiyokotaisa <thel.vadam2485@gmail.com>
(cherry picked from commit 7b86208)
Clarify the documentation for `async` and `poll`; describe the behavior when `poll` = 0 and when it does not.

* Update docs/docsite/rst/user_guide/playbooks_async.rst

* Update the default poll value in async doc

Co-Authored-By: tacatac <taca@kadisius.eu>
(cherry picked from commit dbc64ae)
* expand documentation on how to use lookup plugin aws_service_ip_ranges with ec2_group module

* fix rst syntax error

(cherry picked from commit bb5059f)
Make vars match tasks in Google Compute guide.

(cherry picked from commit 943f733)
…sible#55941)

Docs: Clarify that multiple failed_when conditions join with AND not OR to counter third-party pages online incorrectly stating that it uses `OR`. ([example](https://groups.google.com/d/msg/ansible-project/cIaQTmY3ZLE/c5w8rlmdHWIJ)).
(cherry picked from commit 5439eb8)
…nsible#55931)

* Update docs/docsite/rst/dev_guide/developing_module_utilities.rst

(cherry picked from commit 8542459)
ansible#52008)

* dev_guide: correct path, list requirements, etc.; module HTML docs are in '_build/html/module' subdir

(cherry picked from commit b14f477)
…5747)

* Update docs for the 2.7 change to AnsiballZ which invokes modules with one
  less Python interpreter

* Add a section on how module results are returned and on trust between modules, action plugins, and the executor.

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-Authored-By: abadger <a.badger@gmail.com>
(cherry picked from commit edafa71)
* add doc example of multiline failed_when with OR

* add variety to multiple OR failed_when doc example

(cherry picked from commit 7d5ada7)
… much more (ansible#50205)

* Note that the regex test behaves like 'match', with default settings

(cherry picked from commit 86e98c5)
also add warning about what it covers.

(cherry picked from commit 8ff27c4)
* Fix var naming in GCE guide

(cherry picked from commit dae5564)
* Document the clarifications that I usually remark when doing reviews
* Update docs/docsite/rst/dev_guide/developing_modules_documenting.rst

Co-Authored-By: dagwieers <dag@wieers.com>
(cherry picked from commit eac7f1f)
When installing Ansible on older Ubuntu distributions be aware of the lack of ``-u`` or ``--update`` flag.

+label: docsite_pr

(cherry picked from commit dd0b0ae)
@acozine acozine added backport This PR does not target the devel branch. docs This issue/PR relates to or includes documentation. labels May 10, 2019
@ansibot
Copy link
Contributor

ansibot commented May 10, 2019

@ansibot ansibot added affects_2.8 This issue/PR affects Ansible v2.8 aws cloud core_review In order to be merged, this PR must follow the core review workflow. docsite This issue/PR relates to the documentation website. support:core This issue/PR relates to code supported by the Ansible Engineering Team. windows Windows community labels May 10, 2019
@acozine acozine merged commit c05b617 into ansible:stable-2.8 May 13, 2019
@acozine acozine deleted the backport/2.8/docs_rst_omnibus branch May 20, 2019 18:19
@ansible ansible locked and limited conversation to collaborators Aug 5, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.8 This issue/PR affects Ansible v2.8 aws backport This PR does not target the devel branch. cloud 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. support:core This issue/PR relates to code supported by the Ansible Engineering Team. windows Windows community
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet