diff options
author | Alicia Cozine <879121+acozine@users.noreply.github.com> | 2019-10-08 19:33:58 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-10-08 19:33:58 -0500 |
commit | 4e5c13e0757bd5b1fbd7add33da1edfea23fe3fc (patch) | |
tree | fe75bcdafca243a1430828ef2bade86857131bca /docs/docsite/rst/user_guide | |
parent | d29802ee46bab088cf24c529203ffb3b59f8246a (diff) | |
download | ansible-4e5c13e0757bd5b1fbd7add33da1edfea23fe3fc.tar.gz |
Backport/2.9/docs (#63247)
* add more anchors to collections docs (#62827)
(cherry picked from commit 7e01de96d741c6fb8a1ce04f92873ffb57c9b1b5)
* add anchors to support galaxy links (#62808)
(cherry picked from commit 1b3bf33bdf2530adb3a7cbf8055007acb09b3bb2)
* doc: fix typos (#62852)
(cherry picked from commit b33ae1494936cd04fa89bce51e6068829fc89a91)
* Add some documentation about using plugins in collections (#62465)
- FQCN requirements
- Sharing code in collections
- Limitations with inventory caching
(cherry picked from commit d41050b28b2d3e8d4a97ce13344b04fc87f703a2)
* Remove Latin phrases from the docs (#62419)
* add styleguide about avoiding use of latin words
(cherry picked from commit e7436e278f8945dd73b066c47280c1a17bc18ebe)
* ovirt: Fixing typo in ovirt_disk examples (#62962)
(cherry picked from commit 50dc41cca2e6d75a05e933c5286f41bde235b65f)
* vmware guidlines: adjust the location of cloud-config-vcenter.ini.template (#62970)
Update the location of the cloud-config-vcenter.ini.template template.
The file has been moved by: 2e7d36a3f969b31570d7ee34e3f1f971c5c586a9.
(cherry picked from commit 7ecfa4a471ae17ee15aa51f684bf7d340805d432)
* Prefer https:// links in the docs site (#62939)
This is a follow-up of last year's 1a11cec. It deals with links which
at that point either were not present or did not support https://.
(cherry picked from commit c8315bfd6097f680ae79de5e4d4ee23d0c1068c0)
* fix minor typos (#62950)
(cherry picked from commit ad580a71c475b570cdbd4c79aaf0082ecccdf5fc)
* Modernize Vagrant documentation (#62923)
* By requiring a slightly newer Vagrant version (from 2015) we get the
same generated Ansible inventory format is still used by today's
version of Vagrant. That extended inventory format also has the
benefit of allowing for simpler Ansible examples.
* Switching to a current and supported Ubuntu LTS version.
(cherry picked from commit 0d79013f51ca67eddcb1a3f6ff0f4453b659ee81)
* add ios/iosxr deprecated modules (#62908)
(cherry picked from commit 6bbd9c9eca5992d9fc53dd8fd8814205afaf508d)
Diffstat (limited to 'docs/docsite/rst/user_guide')
6 files changed, 13 insertions, 7 deletions
diff --git a/docs/docsite/rst/user_guide/collections_using.rst b/docs/docsite/rst/user_guide/collections_using.rst index 3a180a7a0f..61f04749eb 100644 --- a/docs/docsite/rst/user_guide/collections_using.rst +++ b/docs/docsite/rst/user_guide/collections_using.rst @@ -12,6 +12,8 @@ You can install and use collections through `Ansible Galaxy <https://galaxy.ansi :local: :depth: 2 +.. _collections_installing: + Installing collections ====================== @@ -49,6 +51,10 @@ You can also keep a collection adjacent to the current playbook, under a ``colle │ └── my_collection/<collection structure lives here> +See :ref:`collection_structure` for details on the collection directory structure. + +.. _collections_older_version: + Installing an older version of a collection ------------------------------------------- diff --git a/docs/docsite/rst/user_guide/playbooks_best_practices.rst b/docs/docsite/rst/user_guide/playbooks_best_practices.rst index 3ce8dfd700..a63c56c1c6 100644 --- a/docs/docsite/rst/user_guide/playbooks_best_practices.rst +++ b/docs/docsite/rst/user_guide/playbooks_best_practices.rst @@ -427,7 +427,7 @@ Alternatively, if only variables are needed:: - hosts: all tasks: - - name: Set OS distribution dependant variables + - name: Set OS distribution dependent variables include_vars: "os_{{ ansible_facts['distribution'] }}.yml" - debug: var: asdf diff --git a/docs/docsite/rst/user_guide/playbooks_filters.rst b/docs/docsite/rst/user_guide/playbooks_filters.rst index dca9cf9fa8..aff571a03c 100644 --- a/docs/docsite/rst/user_guide/playbooks_filters.rst +++ b/docs/docsite/rst/user_guide/playbooks_filters.rst @@ -286,7 +286,7 @@ To always exhaust all list use ``zip_longest``:: msg: "{{ [1,2,3] | zip_longest(['a','b','c','d','e','f'], [21, 22, 23], fillvalue='X') | list }}" -Similarly to the output of the ``items2dict`` filter mentioned above, these filters can be used to contruct a ``dict``:: +Similarly to the output of the ``items2dict`` filter mentioned above, these filters can be used to construct a ``dict``:: {{ dict(keys_list | zip(values_list)) }} @@ -565,7 +565,7 @@ Or, alternatively print out the ports in a comma separated string:: .. note:: Here, quoting literals using backticks avoids escaping quotes and maintains readability. -Or, using YAML `single quote escaping <http://yaml.org/spec/current.html#id2534365>`_:: +Or, using YAML `single quote escaping <https://yaml.org/spec/current.html#id2534365>`_:: - name: "Display all ports from cluster1" debug: @@ -824,7 +824,7 @@ To sort a VLAN list:: {{ [3003, 3004, 3005, 100, 1688, 3002, 3999] | vlan_parser }} -This example renders the folllowing sorted list:: +This example renders the following sorted list:: ['100,1688,3002-3005,3999'] diff --git a/docs/docsite/rst/user_guide/playbooks_variables.rst b/docs/docsite/rst/user_guide/playbooks_variables.rst index 53bbafd27f..b5dd80788b 100644 --- a/docs/docsite/rst/user_guide/playbooks_variables.rst +++ b/docs/docsite/rst/user_guide/playbooks_variables.rst @@ -1229,7 +1229,7 @@ For information about advanced YAML syntax used to declare variables and have mo Best practices in playbooks :ref:`special_variables` List of special variables - `User Mailing List <http://groups.google.com/group/ansible-devel>`_ + `User Mailing List <https://groups.google.com/group/ansible-devel>`_ Have a question? Stop by the google group! `irc.freenode.net <http://irc.freenode.net>`_ #ansible IRC chat channel diff --git a/docs/docsite/rst/user_guide/windows_dsc.rst b/docs/docsite/rst/user_guide/windows_dsc.rst index 649c1d0998..a78f09b8eb 100644 --- a/docs/docsite/rst/user_guide/windows_dsc.rst +++ b/docs/docsite/rst/user_guide/windows_dsc.rst @@ -84,7 +84,7 @@ used - in this case the ``resource_name`` should be set to ``Registry``. The installed; if left blank it will default to the latest version. The other options are parameters that are used to define the resource, such as ``Key`` and ``ValueName``. While the options in the task are not case sensitive, -keeping the case as-is is recommended becuase it makes it easier to distinguish DSC +keeping the case as-is is recommended because it makes it easier to distinguish DSC resource options from Ansible's ``win_dsc`` options. This is what the Ansible task version of the above DSC Registry resource would look like: diff --git a/docs/docsite/rst/user_guide/windows_usage.rst b/docs/docsite/rst/user_guide/windows_usage.rst index 6ce5dea2d3..245db79664 100644 --- a/docs/docsite/rst/user_guide/windows_usage.rst +++ b/docs/docsite/rst/user_guide/windows_usage.rst @@ -388,7 +388,7 @@ standard: .. Note:: You should only quote strings when it is absolutely necessary or required by YAML, and then use single quotes. -The YAML specification considers the following `escape sequences <http://yaml.org/spec/current.html#id2517668>`_: +The YAML specification considers the following `escape sequences <https://yaml.org/spec/current.html#id2517668>`_: * ``\0``, ``\\``, ``\"``, ``\_``, ``\a``, ``\b``, ``\e``, ``\f``, ``\n``, ``\r``, ``\t``, ``\v``, ``\L``, ``\N`` and ``\P`` -- Single character escape |