Remove ":doc:" references from a bunch of doc/* files

mcpanayides · Dec 15, 2016 · 4aafa41 · 4aafa41
1 parent 02bfe79
commit 4aafa41
Show file tree

Hide file tree

Showing 37 changed files with 88 additions and 67 deletions.
diff --git a/HACKING.rst b/HACKING.rst
@@ -229,7 +229,7 @@ Edit the minion config file:
     also running a non-development version of Salt, then you will have to
     change the ``master_port`` value in the minion config to match.
 
-.. note:: Using `salt-call` with a :doc:`Standalone Minion </topics/tutorials/standalone_minion>`
+.. note:: Using `salt-call` with a :ref:`Standalone Minion <tutorial-standalone-minion>`
 
     If you plan to run `salt-call` with this self-contained development
     environment in a masterless setup, you should invoke `salt-call` with

diff --git a/doc/_incl/requisite_incl.rst b/doc/_incl/requisite_incl.rst
@@ -1,6 +1,6 @@
 **Before continuing** make sure you have a working Salt installation by
-following the :doc:`installation </topics/installation/index>` and the
-:doc:`configuration </ref/configuration/index>` instructions.
+following the :ref:`installation` and the
+:ref:`configuration <configuring-salt>` instructions.
 
 .. admonition:: Stuck?
 

diff --git a/doc/faq.rst b/doc/faq.rst
@@ -28,22 +28,22 @@ SaltStack the company does make proprietary products which use Salt and its libr
 .. _`Apache 2.0 license`: http://www.apache.org/licenses/LICENSE-2.0.html
 
 I think I found a bug! What should I do?
------------------------------------------
+----------------------------------------
 
 The salt-users mailing list as well as the salt IRC channel can both be helpful
 resources to confirm if others are seeing the issue and to assist with
 immediate debugging.
 
 To report a bug to the Salt project, please follow the instructions in
-:doc:`reporting a bug </topics/development/reporting_bugs>`.
+:ref:`reporting a bug <reporting-bugs>`.
 
 
 What ports should I open on my firewall?
 ----------------------------------------
 
 Minions need to be able to connect to the Master on TCP ports 4505 and 4506.
 Minions do not need any inbound ports open. More detailed information on
-firewall settings can be found :doc:`here </topics/tutorials/firewall>`.
+firewall settings can be found :ref:`here <firewall>`.
 
 I'm seeing weird behavior (including but not limited to packages not installing their users properly)
 -----------------------------------------------------------------------------------------------------
@@ -207,7 +207,7 @@ Does Salt support backing up managed files?
 -------------------------------------------
 
 Yes. Salt provides an easy to use addition to your file.managed states that
-allow you to back up files via :doc:`backup_mode </ref/states/backup_mode>`,
+allow you to back up files via :ref:`backup_mode <file-state-backups>`,
 backup_mode can be configured on a per state basis, or in the minion config
 (note that if set in the minion config this would simply be the default
 method to use, you still need to specify that the file should be backed up!).

diff --git a/doc/ref/cli/salt-key.rst b/doc/ref/cli/salt-key.rst
@@ -1,3 +1,5 @@
+.. _salt-key:
+
 ============
 ``salt-key``
 ============

diff --git a/doc/ref/configuration/index.rst b/doc/ref/configuration/index.rst
@@ -27,7 +27,7 @@ interfaces (0.0.0.0). To bind Salt to a specific IP, redefine the
    + interface: 10.0.0.1
 
 After updating the configuration file, restart the Salt master.
-See the :doc:`master configuration reference </ref/configuration/master>`
+See the :ref:`master configuration reference <configuration-salt-master>`
 for more details about other configurable options.
 
 Minion Configuration
@@ -48,7 +48,7 @@ configuration file, typically ``/etc/salt/minion``, as follows:
    + master: 10.0.0.1
 
 After updating the configuration file, restart the Salt minion.
-See the :doc:`minion configuration reference </ref/configuration/minion>`
+See the :ref:`minion configuration reference <configuration-salt-minion>`
 for more details about other configurable options.
 
 Running Salt
@@ -78,8 +78,8 @@ Running Salt
 
         salt-master --log-level=debug
 
-    For information on salt's logging system please see the :doc:`logging
-    document</ref/configuration/logging/index>`.
+    For information on salt's logging system please see the :ref:`logging
+    document<logging>`.
 
 
 .. admonition:: Run as an unprivileged (non-root) user
@@ -97,10 +97,10 @@ Running Salt
     * /var/run/salt
 
     More information about running salt as a non-privileged user can be found
-    :doc:`here </ref/configuration/nonroot>`.
+    :ref:`here <configuration-non-root-user>`.
 
 
-There is also a full :doc:`troubleshooting guide</topics/troubleshooting/index>`
+There is also a full :ref:`troubleshooting guide<troubleshooting>`
 available.
 
 .. _key-identity:
@@ -180,7 +180,7 @@ The ``salt-key`` command allows for signing keys individually or in bulk. The
 example above, using ``-A`` bulk-accepts all pending keys. To accept keys
 individually use the lowercase of the same option, ``-a keyname``.
 
-.. seealso:: :doc:`salt-key manpage </ref/cli/salt-key>`
+.. seealso:: :ref:`salt-key manpage <salt-key>`
 
 Sending Commands
 ================

diff --git a/doc/ref/configuration/logging/handlers/index.rst b/doc/ref/configuration/logging/handlers/index.rst
@@ -1,4 +1,4 @@
-.. conf_log:: external-logging-handlers
+.. _external-logging-handlers:
 
 External Logging Handlers
 -------------------------

diff --git a/doc/ref/configuration/logging/index.rst b/doc/ref/configuration/logging/index.rst
@@ -1,3 +1,5 @@
+.. _logging:
+
 =======
 Logging
 =======
@@ -6,8 +8,8 @@ The salt project tries to get the logging to work for you and help us solve any
 issues you might find along the way.
 
 If you want to get some more information on the nitty-gritty of salt's logging
-system, please head over to the :doc:`logging development
-document</topics/development/logging>`, if all you're after is salt's logging
+system, please head over to the :ref:`logging development
+document<logging-internals>`, if all you're after is salt's logging
 configurations, please continue reading.
 
 
@@ -237,5 +239,5 @@ External Logging Handlers
 -------------------------
 
 Besides the internal logging handlers used by salt, there are some external
-which can be used, see the :doc:`external logging handlers<handlers/index>`
+which can be used, see the :ref:`external logging handlers<external-logging-handlers>`
 document.
diff --git a/doc/ref/configuration/minion.rst b/doc/ref/configuration/minion.rst
@@ -40,7 +40,7 @@ Default: ``salt``
     master: salt
 
 The option can can also be set to a list of masters, enabling
-:doc:`multi-master </topics/tutorials/multimaster>` mode.
+:ref:`multi-master <tutorial-multi-master>` mode.
 
 .. code-block:: yaml
 
@@ -1127,8 +1127,8 @@ and/or having to install specific modules' dependencies in system libraries.
 Default: (empty)
 
 A module provider can be statically overwritten or extended for the minion via
-the ``providers`` option. This can be done :doc:`on an individual basis in an
-SLS file <../states/providers>`, or globally here in the minion config, like
+the ``providers`` option. This can be done :ref:`on an individual basis in an
+SLS file <state-providers>`, or globally here in the minion config, like
 below.
 
 .. code-block:: yaml

diff --git a/doc/ref/configuration/nonroot.rst b/doc/ref/configuration/nonroot.rst
@@ -1,3 +1,5 @@
+.. _configuration-non-root-user:
+
 ======================================================
 Running the Salt Master/Minion as an Unprivileged User
 ======================================================

diff --git a/doc/ref/states/highstate.rst b/doc/ref/states/highstate.rst
@@ -25,7 +25,7 @@ during state execution.
 
 Configurable via :conf_master:`state_top`.
 
-.. seealso:: :doc:`A detailed description of the top file </ref/states/top>`
+.. seealso:: :ref:`A detailed description of the top file <states-top>`
 
 .. _include-declaration:
 
@@ -115,7 +115,7 @@ declaration that will restart Apache whenever the Apache configuration file,
     <requisites-watch-in>` or :ref:`require_in <requisites-require-in>` syntax
     instead of extending another ``SLS`` file.
 
-    :doc:`State Requisites </ref/states/requisites>`
+    :ref:`State Requisites <requisites>`
 
 .. _state-declaration:
 

diff --git a/doc/ref/states/top.rst b/doc/ref/states/top.rst
@@ -220,8 +220,8 @@ Advanced Minion Targeting
 =========================
 
 In addition to globs, minions can be specified in top files a few other
-ways. Some common ones are :doc:`compound matches </topics/targeting/compound>`
-and :doc:`node groups </topics/targeting/nodegroups>`.
+ways. Some common ones are :ref:`compound matches <targeting-compound>`
+and :ref:`node groups <targeting-nodegroups>`.
 
 Below is a slightly more complex top file example, showing the different types
 of matches you can perform:

diff --git a/doc/topics/cloud/basic.rst b/doc/topics/cloud/basic.rst
@@ -3,7 +3,7 @@ Salt Cloud basic usage
 
 Salt Cloud needs, at least, one configured
 :ref:`Provider <cloud-provider-specifics>`
-and :doc:`Profile <profiles>` to be functional.
+and :ref:`Profile <salt-cloud-profiles>` to be functional.
 
 Creating a VM
 -------------

diff --git a/doc/topics/cloud/install/index.rst b/doc/topics/cloud/install/index.rst
@@ -2,7 +2,7 @@ Install Salt Cloud
 ==================
 
 Salt Cloud is now part of Salt proper.  It was merged in as of
-:doc:`Salt version 2014.1.0 </topics/releases/2014.1.0>`.
+:ref:`Salt version 2014.1.0 <release-2014-1-0>`.
 
 On Ubuntu, install Salt Cloud by using following command:
 
@@ -28,4 +28,4 @@ Installing Salt Cloud for development
 Installing Salt for development enables Salt Cloud development as well, just
 make sure ``apache-libcloud`` is installed as per above paragraph.
 
-See these instructions: :doc:`Installing Salt for development </topics/development/hacking>`.
+See these instructions: :ref:`Installing Salt for development <installing-for-development>`.
diff --git a/doc/topics/cloud/lxc.rst b/doc/topics/cloud/lxc.rst
@@ -101,7 +101,7 @@ Here are the options to configure your containers:
     dnsservers
         List of DNS servers to use. This is optional.
     minion
-        minion configuration (see :doc:`Minion Configuration in Salt Cloud </topics/cloud/config>`)
+        minion configuration (see :ref:`Minion Configuration in Salt Cloud <salt-cloud-config>`)
     bootstrap_delay
         specify the time to wait (in seconds) between container creation
         and salt bootstrap execution. It is useful to ensure that all essential services

diff --git a/doc/topics/cloud/openstack.rst b/doc/topics/cloud/openstack.rst
@@ -131,8 +131,8 @@ ssh_interface
     for a certain period of time and then destroys the VM. With the nova drive,
     private cloud networks can be defined here.
 
-For more information concerning cloud profiles, see :doc:`here
-</topics/cloud/profiles>`.
+For more information concerning cloud profiles, see :ref:`here
+<salt-cloud-profiles>`.
 
 
 change_password

diff --git a/doc/topics/cloud/profitbricks.rst b/doc/topics/cloud/profitbricks.rst
@@ -144,5 +144,5 @@ ssh_interface
 deploy
     Set to False if Salt should not be installed on the node.
 
-For more information concerning cloud profiles, see :doc:`here
-</topics/cloud/profiles>`.
+For more information concerning cloud profiles, see :ref:`here
+<salt-cloud-profiles>`.
diff --git a/doc/topics/cloud/troubleshooting.rst b/doc/topics/cloud/troubleshooting.rst
@@ -10,7 +10,7 @@ Virtual Machines Are Created, But Do Not Respond
 
 Are TCP ports 4505 and 4506 open on the master? This is easy to overlook on new
 masters. Information on how to open firewall ports on various platforms can be
-found :doc:`here </topics/tutorials/firewall>`.
+found :ref:`here <firewall>`.
 
 
 Generic Troubleshooting Steps

diff --git a/doc/topics/development/conventions/style.rst b/doc/topics/development/conventions/style.rst
@@ -135,7 +135,7 @@ When adding a new function or state, where possible try to use a
 
 If you are uncertain what version should be used, either consult a core
 developer in IRC or bring this up when opening your
-:doc:`pull request </topics/development/hacking>` and a core developer will add the proper
+:ref:`pull request <installing-for-development>` and a core developer will add the proper
 version once your pull request has been merged. Bugfixes will be available in a
 bugfix release (i.e. 0.17.1, the first bugfix release for 0.17.0), while new
 features are held for feature releases, and this will affect what version

diff --git a/doc/topics/development/labels.rst b/doc/topics/development/labels.rst
@@ -37,7 +37,7 @@ coordinate with the assignee via the GitHub issue tracker to create the best pos
     The issue is being actively worked on by a SaltStack engineer.  Sprint milestones names are constructed from the
     chemical symbol of the next release's codename and the number of sprints until that release is made.  For example,
     if the next release codename is ``Neon`` and there are five sprints until that release, the corresponding sprint
-    milestone will be called ``Ne 5``.  See :doc:`<topics/releases/version_numbers>` for a discussion of Salt's release
+    milestone will be called ``Ne 5``.  See :ref:`<version-numbers>` for a discussion of Salt's release
     codenames.
 
 Labels
@@ -295,5 +295,5 @@ with labels.
     The issue is related to a Zendesk customer support ticket.
 
 ``<Release>``
-    The issue is scheduled to be implemented by ``<Release>``.  See :doc:`<topics/releases/version_numbers>` for a
+    The issue is scheduled to be implemented by ``<Release>``.  See :ref:`<version-numbers>` for a
     discussion of Salt's release codenames.
diff --git a/doc/topics/development/logging.rst b/doc/topics/development/logging.rst
@@ -1,3 +1,5 @@
+.. _logging-internals:
+
 =================
 Logging Internals
 =================

diff --git a/doc/topics/development/modular_systems.rst b/doc/topics/development/modular_systems.rst
@@ -24,11 +24,11 @@ detecting information about the system. The only restraint in execution
 modules is that the defined functions always return a JSON serializable
 object.
 
-For a list of all built in execution modules, click :doc:`here
-</ref/modules/all/index>`
+For a list of all built in execution modules, click :ref:`here
+<all-salt_modules>`
 
-For information on writing execution modules, see :doc:`this page
-</ref/modules/index>`.
+For information on writing execution modules, see :ref:`this page
+<writing-execution-modules>`.
 
 
 Interactive Debugging

diff --git a/doc/topics/development/reporting_bugs.rst b/doc/topics/development/reporting_bugs.rst
@@ -1,3 +1,5 @@
+.. _reporting-bugs:
+
 ==============
 Reporting Bugs
 ==============

diff --git a/doc/topics/execution/remote_execution.rst b/doc/topics/execution/remote_execution.rst
@@ -16,7 +16,7 @@ environment variables ``SALT_MASTER_CONFIG`` and ``SALT_MINION_CONFIG``.
 
 .. seealso::
 
-    :doc:`Configuration </ref/configuration/index>`
+    :ref:`Configuration <configuring-salt>`
 
 Using the Salt Command
 ======================

diff --git a/doc/topics/grains/index.rst b/doc/topics/grains/index.rst
@@ -169,8 +169,8 @@ When to Use a Custom Grain
 Before adding new grains, consider what the data is and remember that grains
 should (for the most part) be static data.
 
-If the data is something that is likely to change, consider using :doc:`Pillar
-<../pillar/index>` or an execution module instead. If it's a simple set of
+If the data is something that is likely to change, consider using :ref:`Pillar
+<pillar>` or an execution module instead. If it's a simple set of
 key/value pairs, pillar is a good match. If compiling the information requires
 that system commands be run, then putting this information in an execution
 module is likely a better idea.

diff --git a/doc/topics/highavailability/index.rst b/doc/topics/highavailability/index.rst
@@ -23,7 +23,7 @@ to Salt as well
 
 A tutorial on setting up multimaster with "hot" masters is here:
 
-:doc:`Multimaster Tutorial </topics/tutorials/multimaster>`
+:ref:`Multimaster Tutorial <tutorial-multi-master>`
 
 Multimaster with Failover
 =========================
@@ -42,7 +42,7 @@ Failover can be combined with PKI-style encrypted keys, but PKI is NOT
 REQUIRED to use failover.
 
 Multimaster with PKI and Failover is discussed in
-:doc:`this tutorial </topics/tutorials/multimaster_pki>`
+:ref:`this tutorial <tutorial-multi-master-pki>`
 
 ``master_type: failover`` can be combined with ``master_shuffle: True``
 to spread minion connections across all masters (one master per
@@ -61,7 +61,7 @@ With the syndic, a Salt infrastructure can be partitioned in such a way that
 certain masters control certain segments of the infrastructure, and "Master
 of Masters" nodes can control multiple segments underneath them.
 
-Syndics are covered in depth in :doc:`Salt Syndic </topics/topology/syndic>`.
+Syndics are covered in depth in :ref:`Salt Syndic <syndic>`.
 
 Syndic with Multimaster
 =======================
@@ -71,4 +71,4 @@ Syndic with Multimaster
 Syndic with Multimaster lets you connect a syndic to multiple masters to provide
 an additional layer of redundancy in a syndic configuration.
 
-Syndics are covered in depth in :doc:`Salt Syndic </topics/topology/syndic>`.
+Syndics are covered in depth in :ref:`Salt Syndic <syndic>`.
diff --git a/doc/topics/installation/index.rst b/doc/topics/installation/index.rst
@@ -174,7 +174,7 @@ a security vulnerability.
 
 .. seealso::
 
-    :doc:`Installing Salt for development </topics/development/hacking>` and
+    :ref:`Installing Salt for development <installing-for-development>` and
     contributing to the project.
 
 Building Packages using Salt Pack

diff --git a/doc/topics/jinja/index.rst b/doc/topics/jinja/index.rst
@@ -40,7 +40,7 @@ aren't running FreeBSD, and the second block changes the file name based on the
 *os* grain.
 
 Writing **if-else** blocks can lead to very redundant state files however. In
-this case, using :doc:`pillars</topics/pillar/index>`, or using a previously
+this case, using :ref:`pillars<pillar>`, or using a previously
 defined variable might be easier:
 
 .. code-block:: yaml

diff --git a/doc/topics/jobs/index.rst b/doc/topics/jobs/index.rst
@@ -22,7 +22,7 @@ Functions in the saltutil Module
 ================================
 
 Salt 0.9.7 introduced a few new functions to the
-:doc:`saltutil</ref/modules/all/salt.modules.saltutil>` module for managing
+:mod:`saltutil<salt.modules.saltutil>` module for managing
 jobs. These functions are:
 
 1. ``running``
@@ -108,8 +108,8 @@ Scheduling can be enabled by multiple methods:
 - Minion pillar data.  Schedule is implemented by refreshing the minion's pillar data,
   for example by using ``saltutil.refresh_pillar``.
 
-- The :doc:`schedule state</ref/states/all/salt.states.schedule>` or
-  :doc:`schedule module</ref/modules/all/salt.modules.schedule>`
+- The :mod:`schedule state<salt.states.schedule>` or
+  :mod:`schedule module<salt.modules.schedule>`
 
 .. note::