saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Switch the :formula: extlink to :formula_url:

Browse source 
The addition of the Salt domain conflicted with this role. Better to
rename this one to be more explicit and to save that real-estate for
future use.
This commit is contained in:
Seth House 2014-12-19 13:47:37 -07:00
parent f345188d06
commit a33ae0655f
3 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/conf.py
View file

@ -203,7 +203,7 @@ extlinks = {
'blob': ('https://github.com/saltstack/salt/blob/%s/%%s' % 'develop', None),
'download': ('https://cloud.github.com/downloads/saltstack/salt/%s', None),
'issue': ('https://github.com/saltstack/salt/issues/%s', 'issue '),
'formula': ('https://github.com/saltstack-formulas/%s', ''),
'formula_url': ('https://github.com/saltstack-formulas/%s', ''),
}

4
doc/topics/best_practices.rst
View file

@ -27,7 +27,7 @@ directory structure. A proper directory structure clearly defines the
functionality of each state to the user via visual inspection of the state's
name.
Reviewing the :formula:`MySQL Salt Formula <mysql-formula>`
Reviewing the :formula_url:`MySQL Salt Formula <mysql-formula>`
it is clear to see the benefits to the end-user when reviewing a sample of the
available states:
@ -54,7 +54,7 @@ file in the following way:
This clear definition ensures that the user is properly informed of what each
state will do.
Another example comes from the :formula:`vim-formula`:
Another example comes from the :formula_url:`vim-formula`:
.. code-block:: bash

14
doc/topics/development/conventions/formulas.rst
View file

@ -16,7 +16,7 @@ https://github.com/saltstack-formulas
As a simple example, to install the popular Apache web server (using the normal
defaults for the underlying distro) simply include the
:formula:`apache-formula` from a top file:
:formula_url:`apache-formula` from a top file:
.. code-block:: yaml
@ -106,7 +106,7 @@ Formula may be included in an existing ``sls`` file. This is often useful when
a state you are writing needs to ``require`` or ``extend`` a state defined in
the formula.
Here is an example of a state that uses the :formula:`epel-formula` in a
Here is an example of a state that uses the :formula_url:`epel-formula` in a
``require`` declaration which directs Salt to not install the ``python26``
package until after the EPEL repository has also been installed:
@ -128,7 +128,7 @@ referenced from other state files. It is usually cleanest to include these
Formula directly from a Top File.
For example the easiest way to set up an OpenStack deployment on a single
machine is to include the :formula:`openstack-standalone-formula` directly from
machine is to include the :formula_url:`openstack-standalone-formula` directly from
a :file:`top.sls` file:
.. code-block:: yaml
@ -171,7 +171,7 @@ normal state mechanisms. Formula can be required from other States with
:ref:`requisites-require` declarations, they can be modified using ``extend``,
they can made to watch other states with :ref:`requisites-watch-in`.
The following example uses the stock :formula:`apache-formula` alongside a
The following example uses the stock :formula_url:`apache-formula` alongside a
custom state to create a vhost on a Debian/Ubuntu system and to reload the
Apache service whenever the vhost is changed.
@ -964,7 +964,7 @@ without also including undesirable or unintended side-effects.
The following is a best-practice example for a reusable Apache formula. (This
skips platform-specific options for brevity. See the full
:formula:`apache-formula` for more.)
:formula_url:`apache-formula` for more.)
.. code-block:: yaml
@ -1127,9 +1127,9 @@ A basic Formula repository should have the following layout::
|-- README.rst
`-- VERSION
.. seealso:: :formula:`template-formula`
.. seealso:: :formula_url:`template-formula`
The :formula:`template-formula` repository has a pre-built layout that
The :formula_url:`template-formula` repository has a pre-built layout that
serves as the basic structure for a new formula repository. Just copy the
files from there and edit them.