Skip to content

Commit

Permalink
docs(readme): add documentation regarding salt.formula usage [skip ci]
Browse files Browse the repository at this point in the history
* docs(readme): add documentation regarding salt.formula usage.

* docs(readme): change salt.formulas documentation to use double backtick.

Co-authored-by: Imran Iqbal <myii@users.noreply.github.com>
  • Loading branch information
SamJoan and myii committed Jun 2, 2021
1 parent 1399ccb commit 209575f
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,17 @@ Undo the effects of ``salt.pkgrepo`` on Debian, RedHat, and SuSE.

Clone selected `Salt formulas
<http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_
Git repositories under ``/srv/formulas`` and makes them available in the
relevant ``file_roots`` settings. Pillar data can be used to customize all
paths, URLs, etc.
Git repositories under ``/srv/formulas`` and makes them available in the relevant ``file_roots`` settings. Please note that in order for ``file_roots`` to be updated, ``salt.master`` must be called after ``salt.formulas``. For example:

Here's a minimal pillar sample installing two formulas in the base
environment.
::

base:
'saltmain':
- salt.formulas
- salt.master

Pillar data can be used to customize all paths, URLs, etc. Here's a minimal pillar sample installing two formulas in the base environment:

::

Expand Down

0 comments on commit 209575f

Please sign in to comment.