summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn R Barker <john@johnrbarker.com>2018-03-06 09:34:40 +0000
committerGitHub <noreply@github.com>2018-03-06 09:34:40 +0000
commitc4cb7daa6bc1f3821675479491bd11130910c5b9 (patch)
tree8e26da84088c065aba7c17d9ac0c18caa06925e0
parente03b17e2e57b0a161393a044ff7cfd7f367d37b0 (diff)
downloadansible-c4cb7daa6bc1f3821675479491bd11130910c5b9.tar.gz
Link to new network platform pages (#37057) (#37058)
Also fix a few broken links (cherry picked from commit 7a4e270ae08eafae6958c74cbe23cddeb090087e)
-rw-r--r--docs/docsite/rst/network/getting_started/network_differences.rst6
-rw-r--r--docs/docsite/rst/network/user_guide/network_best_practices_2.5.rst12
2 files changed, 9 insertions, 9 deletions
diff --git a/docs/docsite/rst/network/getting_started/network_differences.rst b/docs/docsite/rst/network/getting_started/network_differences.rst
index 9fc4f11e9f..832ba37649 100644
--- a/docs/docsite/rst/network/getting_started/network_differences.rst
+++ b/docs/docsite/rst/network/getting_started/network_differences.rst
@@ -30,7 +30,7 @@ Because network modules execute on the control node instead of on the managed no
"netconf", "XML over SSH", "network_os setting"
"local", "depends on provider", "provider setting"
-Beginning with Ansible 2.5, we recommend using ``network_cli`` or ``netconf`` for ``ansible_connection`` whenever possible. For details on using API over HTTPS connections, see the platform-specific pages.
+Beginning with Ansible 2.5, we recommend using ``network_cli`` or ``netconf`` for ``ansible_connection`` whenever possible. For details on using API over HTTPS connections, see the :ref:`platform-specific <platform_options>` pages.
Modules Organized by Network Platform
@@ -43,7 +43,7 @@ A network platform is a set of network devices with a common operating system th
- Juniper: ``junos_``
- VyOS ``vyos_``
-All modules within a network platform share certain requirements. Some network platforms have specific differences - see the platform-specific documentation for details.
+All modules within a network platform share certain requirements. Some network platforms have specific differences - see the :ref:`platform-specific <platform_options>` documentation for details.
Privilege Escalation: `authorize` and `become`
@@ -76,7 +76,7 @@ Some network platforms support privilege escalation but cannot use ``network_cli
transport: eapi
use_ssl: no
-And you use the ``setting`` variable in your play(s) or task(s):
+And you use the ``eapi`` variable in your play(s) or task(s):
.. code-block:: yaml
diff --git a/docs/docsite/rst/network/user_guide/network_best_practices_2.5.rst b/docs/docsite/rst/network/user_guide/network_best_practices_2.5.rst
index 001d87db29..ebcdca3122 100644
--- a/docs/docsite/rst/network/user_guide/network_best_practices_2.5.rst
+++ b/docs/docsite/rst/network/user_guide/network_best_practices_2.5.rst
@@ -22,10 +22,10 @@ Prerequisites
This example requires the following:
-* **Ansible 2.5** (or higher) installed. See :doc:`../installation_guide/intro_installation` for more information.
+* **Ansible 2.5** (or higher) installed. See :doc:`../../installation_guide/intro_installation` for more information.
* One or more network devices that are compatible with Ansible.
-* Basic understanding of YAML :doc:`../reference_appendices/YAMLSyntax`.
-* Basic understanding of Jinja2 Templates. See :doc:`../user_guide/playbooks_templating` for more information.
+* Basic understanding of YAML :doc:`../../reference_appendices/YAMLSyntax`.
+* Basic understanding of Jinja2 Templates. See :doc:`../../user_guide/playbooks_templating` for more information.
* Basic Linux command line use.
* Basic knowledge of network switch & router configurations.
@@ -118,7 +118,7 @@ Because Ansible is a flexible tool, there are a number of ways to specify connec
.. warning:: Never store passwords in plain text.
-The "Vault" feature of Ansible allows you to keep sensitive data such as passwords or keys in encrypted files, rather than as plain text in your playbooks or roles. These vault files can then be distributed or placed in source control. See :doc:`../user_guide/playbooks_vault` for more information.
+The "Vault" feature of Ansible allows you to keep sensitive data such as passwords or keys in encrypted files, rather than as plain text in your playbooks or roles. These vault files can then be distributed or placed in source control. See :doc:`../../user_guide/playbooks_vault` for more information.
:ansible_connection:
@@ -361,8 +361,8 @@ If you receive an connection error please double check the inventory and Playboo
.. seealso::
- * :doc:`../network/index`
- * :doc:`../user_guide/intro_inventory`
+ * :ref:`network_guide`
+ * :doc:`../../user_guide/intro_inventory`
* :ref:`Vault best practices <best_practices_for_variables_and_vaults>`