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

This commit is contained in:
rallytime 2016-12-15 16:09:27 -07:00
parent 02bfe7912c
commit 4aafa41d22
37 changed files with 88 additions and 67 deletions

View file

@ -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

View file

@ -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?

View file

@ -28,14 +28,14 @@ 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?
@ -43,7 +43,7 @@ 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!).

View file

@ -1,3 +1,5 @@
.. _salt-key:
============
``salt-key``
============

View file

@ -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
================

View file

@ -1,4 +1,4 @@
.. conf_log:: external-logging-handlers
.. _external-logging-handlers:
External Logging Handlers
-------------------------

View file

@ -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.

View file

@ -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

View file

@ -1,3 +1,5 @@
.. _configuration-non-root-user:
======================================================
Running the Salt Master/Minion as an Unprivileged User
======================================================

View file

@ -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:

View file

@ -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:

View file

@ -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
-------------

View file

@ -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>`.

View file

@ -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

View file

@ -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

View file

@ -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>`.

View file

@ -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

View file

@ -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

View file

@ -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.

View file

@ -1,3 +1,5 @@
.. _logging-internals:
=================
Logging Internals
=================

View file

@ -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

View file

@ -1,3 +1,5 @@
.. _reporting-bugs:
==============
Reporting Bugs
==============

View file

@ -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
======================

View file

@ -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.

View file

@ -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>`.

View file

@ -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

View file

@ -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

View file

@ -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::

View file

@ -20,7 +20,7 @@ Using the new `master_tops` option is simple:
master_tops:
ext_nodes: cobbler-external-nodes
for :doc:`Cobbler <../../ref/tops/all/salt.tops.cobbler>` or:
for :mod:`Cobbler <salt.tops.cobbler>` or:
.. code-block:: yaml
@ -29,7 +29,7 @@ for :doc:`Cobbler <../../ref/tops/all/salt.tops.cobbler>` or:
inventory_base_uri: /etc/reclass
classes_uri: roles
for :doc:`Reclass <../../ref/tops/all/salt.tops.reclass_adapter>`.
for :mod:`Reclass <salt.tops.reclass_adapter>`.
It's also possible to create custom master_tops modules. These modules must go
in a subdirectory called `tops` in the `extension_modules` directory.

View file

@ -5,10 +5,9 @@ Orchestrate Runner
==================
Orchestration is accomplished in salt primarily through the :ref:`Orchestrate
Runner <orchestrate-runner>`. Added in version 0.17.0, this Salt :doc:`Runner
</ref/runners/index>` can use the full suite of :doc:`requisites
</ref/states/requisites>` available in states, and can also execute
states/functions using salt-ssh.
Runner <orchestrate-runner>`. Added in version 0.17.0, this Salt :ref:`Runner
<runners>` can use the full suite of :ref:`requisites` available in states,
and can also execute states/functions using salt-ssh.
The Orchestrate Runner
----------------------
@ -20,7 +19,7 @@ The Orchestrate Runner
The Orchestrate Runner (originally called the state.sls runner) offers all
the functionality of the OverState, but with some advantages:
* All :doc:`requisites </ref/states/requisites>` available in states can be
* All :ref:`requisites` available in states can be
used.
* The states/functions will also work on salt-ssh minions.
@ -146,11 +145,11 @@ More Complex Orchestration
~~~~~~~~~~~~~~~~~~~~~~~~~~
Many states/functions can be configured in a single file, which when combined
with the full suite of :doc:`requisites </ref/states/requisites>`, can be used
with the full suite of :ref:`requisites`, can be used
to easily configure complex orchestration tasks. Additionally, the
states/functions will be executed in the order in which they are defined,
unless prevented from doing so by any :doc:`requisites
</ref/states/requisites>`, as is the default in SLS files since 0.17.0.
unless prevented from doing so by any :ref:`requisites`, as is the default in
SLS files since 0.17.0.
.. code-block:: yaml

View file

@ -1,3 +1,5 @@
.. _proxy-minion-beacon:
.. versionadded:: 2015.8.3
===================

View file

@ -21,19 +21,19 @@ your typical housecat would be excellent source material for a PhD thesis.
Salt proxy-minions provide the 'plumbing' that allows device enumeration
and discovery, control, status, remote execution, and state management.
See the :doc:`Proxy Minion Walkthrough </topics/proxyminion/demo>` for an end-to-end
See the :ref:`Proxy Minion Walkthrough <proxy-minion-end-to-end-example>` for an end-to-end
demonstration of a working REST-based proxy minion.
See the :doc:`Proxy Minion SSH Walkthrough </topics/proxyminion/ssh>` for an end-to-end
See the :ref:`Proxy Minion SSH Walkthrough <proxy-minion-ssh-end-to-end-example>` for an end-to-end
demonstration of a working SSH proxy minion.
See :doc:`Proxyminion States </topics/proxyminion/state>` to configure and
See :ref:`Proxyminion States <proxy-minion-states>` to configure and
run ``salt-proxy`` on a remote minion. Specify all your master side
proxy (pillar) configuration and use this state to remotely configure proxies on one
or more minions.
See :doc:`Proxyminion Beacon </topics/proxyminion/beacon>` to help
See :ref:`Proxyminion Beacon <proxy-minion-beacon>` to help
with easy configuration and management of ``salt-proxy`` processes.
New in 2016.3

View file

@ -1,3 +1,5 @@
.. _proxy-minion-ssh-end-to-end-example:
========================================
Salt Proxy Minion SSH End-to-End Example
========================================

View file

@ -1,3 +1,5 @@
.. _proxy-minion-states:
.. versionadded:: 2015.8.2
===================

View file

@ -1,3 +1,5 @@
.. _release-2014-1-0:
===============================================
Salt 2014.1.0 Release Notes - Codename Hydrogen
===============================================

View file

@ -1,5 +1,7 @@
:orphan:
.. _version-numbers:
===============
Version Numbers
===============

View file

@ -1,3 +1,5 @@
.. _troubleshooting:
===============
Troubleshooting
===============