From 209575f385ea352a36c00b60d3bf67b100f16f9d Mon Sep 17 00:00:00 2001 From: Pedro Worcel Date: Thu, 3 Jun 2021 03:02:19 +1200 Subject: [PATCH] docs(readme): add documentation regarding salt.formula usage [skip ci] * docs(readme): add documentation regarding salt.formula usage. * docs(readme): change salt.formulas documentation to use double backtick. Co-authored-by: Imran Iqbal --- docs/README.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/README.rst b/docs/README.rst index 96ea61ae7..7e86882de 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -126,12 +126,17 @@ Undo the effects of ``salt.pkgrepo`` on Debian, RedHat, and SuSE. Clone selected `Salt formulas `_ -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: ::