From ea765be9931fd231e2687e23a013842497bbb85d Mon Sep 17 00:00:00 2001 From: Alicia Cozine Date: Thu, 19 Apr 2018 19:02:30 -0500 Subject: [PATCH] Link fixes (#39038) * fixes links on plugins pages * fixes links in community pages * fixes links in user guide * adds anchors on playbooks pages (cherry picked from commit 408e29cbd2ed4d2e2753d6b303cf26e3b0e610a7) --- docs/docsite/rst/community/communication.rst | 2 ++ docs/docsite/rst/community/maintainers.rst | 6 ++-- .../community/reporting_bugs_and_features.rst | 2 ++ docs/docsite/rst/plugins/action.rst | 4 +-- docs/docsite/rst/plugins/cache.rst | 4 +-- docs/docsite/rst/plugins/callback.rst | 8 ++--- docs/docsite/rst/plugins/connection.rst | 31 +++++++++---------- docs/docsite/rst/plugins/inventory.rst | 10 +++--- docs/docsite/rst/plugins/lookup.rst | 14 ++++----- docs/docsite/rst/plugins/plugins.rst | 6 ++-- docs/docsite/rst/plugins/shell.rst | 8 ++--- docs/docsite/rst/plugins/strategy.rst | 12 +++---- docs/docsite/rst/plugins/vars.rst | 2 +- .../rst/user_guide/intro_getting_started.rst | 2 +- .../rst/user_guide/playbooks_lookups.rst | 2 ++ .../user_guide/playbooks_reuse_includes.rst | 2 +- .../rst/user_guide/playbooks_tests.rst | 2 +- 17 files changed, 62 insertions(+), 55 deletions(-) diff --git a/docs/docsite/rst/community/communication.rst b/docs/docsite/rst/community/communication.rst index f61d56c969e..7d31e6f0592 100644 --- a/docs/docsite/rst/community/communication.rst +++ b/docs/docsite/rst/community/communication.rst @@ -1,3 +1,5 @@ +.. _communication: + ************* Communicating ************* diff --git a/docs/docsite/rst/community/maintainers.rst b/docs/docsite/rst/community/maintainers.rst index c4f21a638d3..c25629b243a 100644 --- a/docs/docsite/rst/community/maintainers.rst +++ b/docs/docsite/rst/community/maintainers.rst @@ -1,3 +1,5 @@ +.. _maintainers: + **************************** Module Maintainer Guidelines **************************** @@ -8,8 +10,8 @@ Thank you for being a maintainer of part of Ansible's codebase. This guide provi In addition to the information below, module maintainers should be familiar with: -* :ref:`General Ansible community development practices <../community>` -* Documentation on :ref:`module development <../dev_guide/developing_modules>` +* :ref:`General Ansible community development practices ` +* Documentation on :ref:`module development ` Maintainer Responsibilities diff --git a/docs/docsite/rst/community/reporting_bugs_and_features.rst b/docs/docsite/rst/community/reporting_bugs_and_features.rst index 1e2d9e24e36..1a8c7aa5f7c 100644 --- a/docs/docsite/rst/community/reporting_bugs_and_features.rst +++ b/docs/docsite/rst/community/reporting_bugs_and_features.rst @@ -1,3 +1,5 @@ +.. _reporting_bugs_and_features: + ************************************** Reporting Bugs And Requesting Features ************************************** diff --git a/docs/docsite/rst/plugins/action.rst b/docs/docsite/rst/plugins/action.rst index e2e7693f8ba..66cf4f53706 100644 --- a/docs/docsite/rst/plugins/action.rst +++ b/docs/docsite/rst/plugins/action.rst @@ -5,7 +5,7 @@ Action Plugins :local: :depth: 2 -Action plugins act in conjunction with :doc:`modules <../modules>` to execute the actions required by playbook tasks. +Action plugins act in conjunction with :ref:`modules ` to execute the actions required by playbook tasks. They usually execute automatically in the background doing prerequisite work before modules execute. The 'normal' action plugin is used for modules that do not already have an action plugin. @@ -15,7 +15,7 @@ The 'normal' action plugin is used for modules that do not already have an actio Enabling Action Plugins ----------------------- -You can enable a custom action plugin by either dropping it into the ``action_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the action plugin directory sources configured in :doc:`ansible.cfg <../config>`. +You can enable a custom action plugin by either dropping it into the ``action_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the action plugin directory sources configured in :ref:`ansible.cfg `. .. _using_action: diff --git a/docs/docsite/rst/plugins/cache.rst b/docs/docsite/rst/plugins/cache.rst index 98f0f8d2665..a6e3ef7e432 100644 --- a/docs/docsite/rst/plugins/cache.rst +++ b/docs/docsite/rst/plugins/cache.rst @@ -30,9 +30,9 @@ or in the ``ansible.cfg`` file: fact_caching=redis You will also need to configure other settings specific to each plugin. Consult the individual plugin documentation -or the Ansible :doc:`configuration <../config>` for more details. +or the Ansible :ref:`configuration ` for more details. -A custom cache plugin is enabled by dropping it into a ``cache_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the directory sources configured in :doc:`ansible.cfg <../config>`. +A custom cache plugin is enabled by dropping it into a ``cache_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the directory sources configured in :ref:`ansible.cfg `. .. _using_cache: diff --git a/docs/docsite/rst/plugins/callback.rst b/docs/docsite/rst/plugins/callback.rst index 08fe8d8b363..ff9f18721ae 100644 --- a/docs/docsite/rst/plugins/callback.rst +++ b/docs/docsite/rst/plugins/callback.rst @@ -13,7 +13,7 @@ but can also be used to add additional output, integrate with other tools and ma Example Callback Plugins ++++++++++++++++++++++++ -The :doc:`log_plays ` callback is an example of how to record playbook events to a log file, +The :doc:`_plays ` callback is an example of how to record playbook events to a log file, and the :doc:`mail ` callback sends email on playbook failures. The :doc:`osx_say ` callback responds with computer synthesized speech on OS X in relation to playbook events. @@ -24,11 +24,11 @@ The :doc:`osx_say ` callback responds with computer synthesize Enabling Callback Plugins ++++++++++++++++++++++++++ -You can activate a custom callback by either dropping it into a ``callback_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the callback directory sources configured in :doc:`ansible.cfg <../config>`. +You can activate a custom callback by either dropping it into a ``callback_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the callback directory sources configured in :ref:`ansible.cfg `. Plugins are loaded in alphanumeric order. For example, a plugin implemented in a file named `1_first.py` would run before a plugin file named `2_second.py`. -Most callbacks shipped with Ansible are disabled by default and need to be whitelisted in your :doc:`ansible.cfg <../config>` file in order to function. For example: +Most callbacks shipped with Ansible are disabled by default and need to be whitelisted in your :ref:`ansible.cfg ` file in order to function. For example: .. code-block:: ini @@ -38,7 +38,7 @@ Most callbacks shipped with Ansible are disabled by default and need to be white Managing stdout ``````````````` -You can only have one plugin be the main manager of your console output. If you want to replace the default, you should define CALLBACK_TYPE = stdout in the subclass and then configure the stdout plugin in :doc:`ansible.cfg <../config>`. For example: +You can only have one plugin be the main manager of your console output. If you want to replace the default, you should define CALLBACK_TYPE = stdout in the subclass and then configure the stdout plugin in :ref:`ansible.cfg `. For example: .. code-block:: ini diff --git a/docs/docsite/rst/plugins/connection.rst b/docs/docsite/rst/plugins/connection.rst index 8baaa12e778..5168cfa2f45 100644 --- a/docs/docsite/rst/plugins/connection.rst +++ b/docs/docsite/rst/plugins/connection.rst @@ -8,8 +8,7 @@ Connection plugins allow Ansible to connect to the target hosts so it can execut By default, Ansible ships with several plugins. The most commonly used are the 'paramiko' SSH, native ssh (just called 'ssh'), and 'local' connection types. All of these can be used in playbooks and with /usr/bin/ansible to decide how you want to talk to remote machines. -The basics of these connection types are covered in the :doc:`../intro_getting_started` section. - +The basics of these connection types are covered in the :ref:`getting started` section. .. _ssh_plugins: @@ -17,7 +16,7 @@ The basics of these connection types are covered in the :doc:`../intro_getting_s ssh Plugins +++++++++++ -Because ssh is the default protocol used in system administration and the protocol most used in Ansible, ssh options are included in the command line tools. See :doc:`../ansible-playbook` for more details. +Because ssh is the default protocol used in system administration and the protocol most used in Ansible, ssh options are included in the command line tools. See :ref:`ansible-playbook` for more details. .. _enabling_connection: @@ -33,22 +32,22 @@ into the ``connection_plugins`` directory. Using Connection Plugins ++++++++++++++++++++++++ -The transport can be changed via :doc:`configuration <../config>`, in the command line (``-c``, ``--connection``), as a keyword (:ref:`connection`) -in your play, or by setting the a connection variable (:ref:`ansible_connection`), most often in your inventory. -For example, for Windows machines you might want to use the :doc:`winrm ` plugin. +The transport can be changed via :ref:`configuration`, in the command line (``-c``, ``--connection``), as a :ref:`keyword`) +in your play, or by setting a :ref:`variable`, most often in your inventory. +For example, for Windows machines you might want to use the :doc:`winrm` plugin. -Most connection plugins can operate with a minimum configuration. By default they use the :ref:`inventory_hostname` and defaults to find the target host. +Most connection plugins can operate with a minimum configuration. By default they use the :ref:`inventory hostname` and defaults to find the target host. Plugins are self-documenting. Each plugin should document its configuration options. The following are connection variables common to most connection plugins: -:ref:`ansible_host` - The name of the host to connect to, if different from the :ref:`inventory_hostname`. -:ref:`ansible_port` +:ref:`ansible_host` + The name of the host to connect to, if different from the :ref:`inventory hostname`. +:ref:`ansible_port` The ssh port number, for :doc:`ssh ` and :doc:`paramiko ` it defaults to 22. -:ref:`ansible_user` +:ref:`ansible_user` The default user name to use for log in. Most plugins default to the 'current user running Ansible'. -Each plugin might also have a specific version of a variable that overrides the general version. For example, :ref:`ansible_ssh_host` for the :doc:`ssh ` plugin. +Each plugin might also have a specific version of a variable that overrides the general version. For example, :ref:`ansible_ssh_host` for the :doc:`ssh ` plugin. .. _connection_plugin_list: @@ -67,15 +66,15 @@ Use ``ansible-doc -t connection `` to see detailed documentation an .. seealso:: - :doc:`../playbooks` + :ref:`Working with Playbooks` An introduction to playbooks :doc:`callback` Ansible callback plugins - :doc:`../playbooks_filters` + :ref:`Filters` Jinja2 filter plugins - :doc:`../playbooks_tests` + :ref:`Tests` Jinja2 test plugins - :doc:`../playbooks_lookups` + :ref:`Lookups` Jinja2 lookup plugins :doc:`vars` Ansible vars plugins diff --git a/docs/docsite/rst/plugins/inventory.rst b/docs/docsite/rst/plugins/inventory.rst index 588bd1bb2cf..9896726858a 100644 --- a/docs/docsite/rst/plugins/inventory.rst +++ b/docs/docsite/rst/plugins/inventory.rst @@ -13,7 +13,7 @@ Enabling Inventory Plugins ++++++++++++++++++++++++++ Most inventory plugins shipped with Ansible are disabled by default and need to be whitelisted in your -:doc:`ansible.cfg <../config>` file in order to function. This is how the default whitelist looks in the +:ref:`ansible.cfg ` file in order to function. This is how the default whitelist looks in the config file that ships with Ansible: .. code-block:: ini @@ -54,17 +54,17 @@ Use ``ansible-doc -t inventory `` to see plugin-specific documentat .. seealso:: - :doc:`../playbooks` + :ref:`about_playbooks` An introduction to playbooks :doc:`callback` Ansible callback plugins :doc:`connection` Ansible connection plugins - :doc:`../playbooks_filters` + :ref:`playbooks_filters` Jinja2 filter plugins - :doc:`../playbooks_tests` + :ref:`playbooks_tests` Jinja2 test plugins - :doc:`../playbooks_lookups` + :ref:`playbooks_lookups` Jinja2 lookup plugins :doc:`vars` Ansible vars plugins diff --git a/docs/docsite/rst/plugins/lookup.rst b/docs/docsite/rst/plugins/lookup.rst index 691c806ff61..5c61d203323 100644 --- a/docs/docsite/rst/plugins/lookup.rst +++ b/docs/docsite/rst/plugins/lookup.rst @@ -28,7 +28,7 @@ Lookups are an Ansible-specific extension to the Jinja2 templating language. Enabling Lookup Plugins +++++++++++++++++++++++ -You can activate a custom lookup by either dropping it into a ``lookup_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the lookup directory sources configured in :doc:`ansible.cfg <../config>`. +You can activate a custom lookup by either dropping it into a ``lookup_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the lookup directory sources configured in :ref:`ansible.cfg `. .. _using_lookup: @@ -36,7 +36,7 @@ You can activate a custom lookup by either dropping it into a ``lookup_plugins`` Using Lookup Plugins ++++++++++++++++++++ -Lookup plugins can be used anywhere you can use templating in Ansible: in a play, in variables file, or in a Jinja2 template for the :doc:`template <../template_module>` module. +Lookup plugins can be used anywhere you can use templating in Ansible: in a play, in variables file, or in a Jinja2 template for the :ref:`template ` module. .. code-block:: yaml @@ -53,7 +53,7 @@ This is also the reason most lookups output lists and take lists as input; for e debug: msg={{item}} with_items: [1, 2, 3] -You can combine lookups with :doc:`../playbooks_filters`, :doc:`../playbooks_tests` and even each other to do some complex data generation and maniplulation. For example: +You can combine lookups with :ref:`playbooks_filters`, :ref:`playbooks_tests` and even each other to do some complex data generation and manipulation. For example: .. code-block:: yaml @@ -81,17 +81,17 @@ You can use ``ansible-doc -t lookup -l`` to see the list of available plugins. U .. seealso:: - :doc:`../playbooks` + :ref:`about_playbooks` An introduction to playbooks :doc:`inventory` Ansible inventory plugins :doc:`callback` Ansible callback plugins - :doc:`../playbooks_filters` + :ref:`playbooks_filters` Jinja2 filter plugins - :doc:`../playbooks_tests` + :ref:`playbooks_tests` Jinja2 test plugins - :doc:`../playbooks_lookups` + :ref:`playbooks_lookups` Jinja2 lookup plugins `User Mailing List `_ Have a question? Stop by the google group! diff --git a/docs/docsite/rst/plugins/plugins.rst b/docs/docsite/rst/plugins/plugins.rst index 6e6676ae215..4ecbcdb4ed2 100644 --- a/docs/docsite/rst/plugins/plugins.rst +++ b/docs/docsite/rst/plugins/plugins.rst @@ -28,11 +28,11 @@ This section covers the various types of plugins that are included with Ansible: .. seealso:: - :doc:`playbooks` + :ref:`about_playbooks` An introduction to playbooks - :doc:`config` + :ref:`ansible_configuration_settings` Ansible configuration documentation and settings - :doc:`command_line_tools` + :doc:`../user_guide/command_line_tools` Ansible tools, description and options `User Mailing List `_ Have a question? Stop by the google group! diff --git a/docs/docsite/rst/plugins/shell.rst b/docs/docsite/rst/plugins/shell.rst index c0341b6934d..714730393fe 100644 --- a/docs/docsite/rst/plugins/shell.rst +++ b/docs/docsite/rst/plugins/shell.rst @@ -12,22 +12,22 @@ Enabling Shell Plugins ++++++++++++++++++++++ You can add a custom shell plugin by dropping it into a ``shell_plugins`` directory adjacent to your play, inside a role, -or by putting it in one of the shell plugin directory sources configured in :doc:`ansible.cfg <../config>`. +or by putting it in one of the shell plugin directory sources configured in :ref:`ansible.cfg `. .. warning:: You should not alter which plugin is used unless you have a setup in which the default ``/bin/sh`` - is not a POSIX compatible shell or is not availble for execution. + is not a POSIX compatible shell or is not available for execution. .. _using_shell: Using Shell Plugins +++++++++++++++++++ -In addition to the default configuration settings in :doc:`../config`, you can use +In addition to the default configuration settings in :ref:`ansible_configuration_settings`, you can use a 'connection variable' :ref:`ansible_shell_type` to select the plugin to use. In this case, you will also want to update the :ref:`ansible_executable` to match. You can further control the settings for each plugin via other configuration options -detailed in the plugin themsleves (linked below). +detailed in the plugin themselves (linked below). .. toctree:: :maxdepth: 1 :glob: diff --git a/docs/docsite/rst/plugins/strategy.rst b/docs/docsite/rst/plugins/strategy.rst index 5e3bb978145..0ad820b6dc1 100644 --- a/docs/docsite/rst/plugins/strategy.rst +++ b/docs/docsite/rst/plugins/strategy.rst @@ -12,7 +12,7 @@ Enabling Strategy Plugins +++++++++++++++++++++++++ Strategy plugins shipped with Ansible are enabled by default. You can enable a custom strategy plugin by -putting it in one of the lookup directory sources configured in :doc:`ansible.cfg <../config>`. +putting it in one of the lookup directory sources configured in :ref:`ansible.cfg `. .. _using_strategy: @@ -21,7 +21,7 @@ Using Strategy Plugins ++++++++++++++++++++++ Only one strategy plugin can be used in a play, but you can use different ones for each play in a playbook or ansible run. -The default is the :doc:`linear ` plugin. You can change this default in Ansible :doc:`configuration <../config>` using an environment variable: +The default is the :doc:`linear ` plugin. You can change this default in Ansible :ref:`configuration ` using an environment variable: .. code-block:: shell @@ -64,17 +64,17 @@ Use ``ansible-doc -t strategy `` to see plugin-specific specific do .. seealso:: - :doc:`../playbooks` + :ref:`about_playbooks` An introduction to playbooks :doc:`inventory` Ansible inventory plugins :doc:`callback` Ansible callback plugins - :doc:`../playbooks_filters` + :ref:`playbooks_filters` Jinja2 filter plugins - :doc:`../playbooks_tests` + :ref:`playbooks_tests` Jinja2 test plugins - :doc:`../playbooks_lookups` + :ref:`playbooks_lookups` Jinja2 lookup plugins `User Mailing List `_ Have a question? Stop by the google group! diff --git a/docs/docsite/rst/plugins/vars.rst b/docs/docsite/rst/plugins/vars.rst index abedd3d7d3e..bd3cda475dc 100644 --- a/docs/docsite/rst/plugins/vars.rst +++ b/docs/docsite/rst/plugins/vars.rst @@ -16,7 +16,7 @@ The :doc:`host_group_vars ` plugin shipped with Ansible en Enabling Vars Plugins +++++++++++++++++++++ -You can activate a custom vars plugins by either dropping it into a ``vars_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the directory sources configured in :doc:`ansible.cfg <../config>`. +You can activate a custom vars plugins by either dropping it into a ``vars_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the directory sources configured in :ref:`ansible.cfg `. .. _using_vars: diff --git a/docs/docsite/rst/user_guide/intro_getting_started.rst b/docs/docsite/rst/user_guide/intro_getting_started.rst index eb2d5600864..ebd39f01414 100644 --- a/docs/docsite/rst/user_guide/intro_getting_started.rst +++ b/docs/docsite/rst/user_guide/intro_getting_started.rst @@ -10,7 +10,7 @@ Getting Started Foreword ```````` -Now that you've read :ref:`intro_installation` and installed Ansible, it's time to get +Now that you've read the :ref:`installation guide` and installed Ansible, it's time to get started with some ad-hoc commands. What we are showing first are not the powerful configuration/deployment/orchestration features of Ansible. diff --git a/docs/docsite/rst/user_guide/playbooks_lookups.rst b/docs/docsite/rst/user_guide/playbooks_lookups.rst index b0952d6949e..0ee479e3f9c 100644 --- a/docs/docsite/rst/user_guide/playbooks_lookups.rst +++ b/docs/docsite/rst/user_guide/playbooks_lookups.rst @@ -1,3 +1,5 @@ +.. _playbooks_lookups: + Lookups ------- diff --git a/docs/docsite/rst/user_guide/playbooks_reuse_includes.rst b/docs/docsite/rst/user_guide/playbooks_reuse_includes.rst index 1cef651f9e4..c324ef1129c 100644 --- a/docs/docsite/rst/user_guide/playbooks_reuse_includes.rst +++ b/docs/docsite/rst/user_guide/playbooks_reuse_includes.rst @@ -122,7 +122,7 @@ Please refer to :doc:`playbooks_reuse_roles` for details on including and import Loops in playbooks :ref:`all_modules` Learn about available modules - :red:`developing_modules` + :ref:`developing_modules` Learn how to extend Ansible by writing your own modules `GitHub Ansible examples `_ Complete playbook files from the GitHub project source diff --git a/docs/docsite/rst/user_guide/playbooks_tests.rst b/docs/docsite/rst/user_guide/playbooks_tests.rst index 7c3bb7ce5e2..3d13856b1dd 100644 --- a/docs/docsite/rst/user_guide/playbooks_tests.rst +++ b/docs/docsite/rst/user_guide/playbooks_tests.rst @@ -1,4 +1,4 @@ -.. _playbook_tests: +.. _playbooks_tests: Tests -----