docs(map.jinja): add a proper docs/map.jinja.rst

Remove details from the YAML parameter files.
saltstack-formulas · Feb 24, 2020 · 65cc037 · 65cc037
1 parent b771180
commit 65cc037
Show file tree

Hide file tree

Showing 20 changed files with 169 additions and 181 deletions.
diff --git a/TEMPLATE/parameters/os/Fedora.yaml b/TEMPLATE/parameters/os/Fedora.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `os` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   pkg:

diff --git a/TEMPLATE/parameters/os/Ubuntu.yaml b/TEMPLATE/parameters/os/Ubuntu.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `os` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   pkg:

diff --git a/TEMPLATE/parameters/os_family/Arch.yaml b/TEMPLATE/parameters/os_family/Arch.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `os_family` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   pkg:

diff --git a/TEMPLATE/parameters/os_family/Debian.yaml b/TEMPLATE/parameters/os_family/Debian.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `os_family` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   pkg:

diff --git a/TEMPLATE/parameters/os_family/FreeBSD.yaml b/TEMPLATE/parameters/os_family/FreeBSD.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `os_family` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   rootgroup: wheel

diff --git a/TEMPLATE/parameters/os_family/OpenBSD.yaml b/TEMPLATE/parameters/os_family/OpenBSD.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `os_family` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   rootgroup: wheel

diff --git a/TEMPLATE/parameters/os_family/RedHat.yaml b/TEMPLATE/parameters/os_family/RedHat.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `os_family` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   pkg:

diff --git a/TEMPLATE/parameters/os_family/Suse.yaml b/TEMPLATE/parameters/os_family/Suse.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `os_family` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   pkg:

diff --git a/TEMPLATE/parameters/osarch/386.yaml b/TEMPLATE/parameters/osarch/386.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `osarch` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   arch: 386

diff --git a/TEMPLATE/parameters/osarch/amd64.yaml b/TEMPLATE/parameters/osarch/amd64.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `osarch` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   arch: amd64

diff --git a/TEMPLATE/parameters/osarch/arm64.yaml b/TEMPLATE/parameters/osarch/arm64.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `osarch` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   arch: arm64

diff --git a/TEMPLATE/parameters/osarch/armv6l.yaml b/TEMPLATE/parameters/osarch/armv6l.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `osarch` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   arch: armv6l

diff --git a/TEMPLATE/parameters/osarch/armv7l.yaml b/TEMPLATE/parameters/osarch/armv7l.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `osarch` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   arch: armv7l

diff --git a/TEMPLATE/parameters/osarch/ppc64le.yaml b/TEMPLATE/parameters/osarch/ppc64le.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `osarch` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   arch: ppc64le

diff --git a/TEMPLATE/parameters/osarch/s390x.yaml b/TEMPLATE/parameters/osarch/s390x.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `osarch` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   arch: s390x

diff --git a/TEMPLATE/parameters/osarch/x86_64.yaml b/TEMPLATE/parameters/osarch/x86_64.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `osarch` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   arch: amd64

diff --git a/TEMPLATE/parameters/osfinger/CentOS-6.yaml b/TEMPLATE/parameters/osfinger/CentOS-6.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `osfinger` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   pkg:

diff --git a/TEMPLATE/parameters/osfinger/Ubuntu-18.04.yaml b/TEMPLATE/parameters/osfinger/Ubuntu-18.04.yaml
@@ -8,16 +8,6 @@
 # If you do not need to provide defaults via the `osfinger` config,
 # you can remove this file or provide at least an empty dict, e.g.
 # values: {}
-#
-# This file will be merged with `salt.slsutil.merge`:
-#
-# You can select the merging strategy by defining the `strategy` dict
-# with one of: `aggregate`, `list`, `overwrite`, `recurse`, `smart`, e.g.
-# strategy: 'recurse'
-#
-# If you use the `recurse` or `overwrite` strategy, you can aggregate
-# the lists by defining the `merge_lists` dict with a boolean, e.g.
-# merge_lists: 'true'
 ---
 values:
   config: /etc/TEMPLATE.d/custom-ubuntu-18.04.conf

diff --git a/docs/README.rst b/docs/README.rst
@@ -33,7 +33,11 @@ which contains the currently released version. This formula is versioned accordi
 
 See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.
 
-If you need (non-default) configuration, please pay attention to the ``pillar.example`` file and/or `Special notes`_ section.
+If you need (non-default) configuration, please pay attention:
+
+- to the ``pillar.example`` file
+- to `how to configure formula with map.jinja <map.jinja.rst>`_
+- and/or `Special notes`_ section
 
 Contributing to this repo
 -------------------------