feat(map.jinja): add documentation header to parameter files

TEMPLATE/parameters/defaults.yaml

@@ -26,3 +26,4 @@ map.jinja:
     - osfinger
     - roles
     - any/path/can/be/used/here.yaml
+...

TEMPLATE/parameters/os/Amazon.yaml

@@ -2,11 +2,22 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os') == Amazon.
-# You just need to add the key:values for an `os` that differ
+# You just need to add the key:values for this `os` that differ
 # from `defaults.yaml` + `<osarch>.yaml` + `<os_family>.yaml`.
 #
-# If you do not need to provide defaults via the `os` grain,
+# 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: {}
+...

TEMPLATE/parameters/os/CentOS.yaml

@@ -2,11 +2,22 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os') == CentOS.
-# You just need to add the key:values for an `os` that differ
+# You just need to add the key:values for this `os` that differ
 # from `defaults.yaml` + `<osarch>.yaml` + `<os_family>.yaml`.
 #
-# If you do not need to provide defaults via the `os` grain,
+# 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: {}
+...

TEMPLATE/parameters/os/Fedora.yaml

@@ -2,15 +2,26 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os') == Fedora.
-# You just need to add the key:values for an `os` that differ
+# You just need to add the key:values for this `os` that differ
 # from `defaults.yaml` + `<osarch>.yaml` + `<os_family>.yaml`.
 #
-# If you do not need to provide defaults via the `os` grain,
+# 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:
     name: TEMPLATE-fedora
   service:
     name: service-fedora
+...

TEMPLATE/parameters/os/Funtoo.yaml

@@ -2,11 +2,22 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os') == Funtoo.
-# You just need to add the key:values for an `os` that differ
+# You just need to add the key:values for this `os` that differ
 # from `defaults.yaml` + `<osarch>.yaml` + `<os_family>.yaml`.
 #
-# If you do not need to provide defaults via the `os` grain,
+# 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: {}
+...

TEMPLATE/parameters/os/Manjaro.yaml

@@ -2,11 +2,22 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os') == Manjaro.
-# You just need to add the key:values for an `os` that differ
+# You just need to add the key:values for this `os` that differ
 # from `defaults.yaml` + `<osarch>.yaml` + `<os_family>.yaml`.
 #
-# If you do not need to provide defaults via the `os` grain,
+# 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: {}
+...

TEMPLATE/parameters/os/Raspbian.yaml

@@ -2,11 +2,22 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os') == Raspbian.
-# You just need to add the key:values for an `os` that differ
+# You just need to add the key:values for this `os` that differ
 # from `defaults.yaml` + `<osarch>.yaml` + `<os_family>.yaml`.
 #
-# If you do not need to provide defaults via the `os` grain,
+# 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: {}
+...

TEMPLATE/parameters/os/SUSE.yaml

@@ -2,11 +2,22 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os') == SUSE.
-# You just need to add the key:values for an `os` that differ
+# You just need to add the key:values for this `os` that differ
 # from `defaults.yaml` + `<osarch>.yaml` + `<os_family>.yaml`.
 #
-# If you do not need to provide defaults via the `os` grain,
+# 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: {}
+...

TEMPLATE/parameters/os/SmartOS.yaml

@@ -2,11 +2,22 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os') == SmartOS.
-# You just need to add the key:values for an `os` that differ
+# You just need to add the key:values for this `os` that differ
 # from `defaults.yaml` + `<osarch>.yaml` + `<os_family>.yaml`.
 #
-# If you do not need to provide defaults via the `os` grain,
+# 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: {}
+...

TEMPLATE/parameters/os/Ubuntu.yaml

@@ -2,14 +2,25 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os') == Ubuntu.
-# You just need to add the key:values for an `os` that differ
+# You just need to add the key:values for this `os` that differ
 # from `defaults.yaml` + `<osarch>.yaml` + `<os_family>.yaml`.
 #
-# If you do not need to provide defaults via the `os` grain,
+# 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:
     name: TEMPLATE-ubuntu
   config: /etc/TEMPLATE.d/custom-ubuntu.conf
+...

TEMPLATE/parameters/os/openSUSE.yaml

@@ -2,11 +2,22 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os') == openSUSE.
-# You just need to add the key:values for an `os` that differ
+# You just need to add the key:values for this `os` that differ
 # from `defaults.yaml` + `<osarch>.yaml` + `<os_family>.yaml`.
 #
-# If you do not need to provide defaults via the `os` grain,
+# 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: {}
+...

TEMPLATE/parameters/os_family/Alpine.yaml

@@ -2,11 +2,22 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os_family') == Alpine.
-# You just need to add the key:values for an `os_family` that differ
+# You just need to add the key:values for this `os_family` that differ
 # from `defaults.yaml` + `<osarch>.yaml`.
 #
-# If you do not need to provide defaults via the `os_family` grain,
+# 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: {}
+...

TEMPLATE/parameters/os_family/Arch.yaml

@@ -2,15 +2,27 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os_family') == Arch.
-# You just need to add the key:values for an `os_family` that differ
+# You just need to add the key:values for this `os_family` that differ
 # from `defaults.yaml` + `<osarch>.yaml`.
 #
-# If you do not need to provide defaults via the `os_family` grain,
+# 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:
     name: TEMPLATE-arch
   service:
     name: service-arch
+
+...

TEMPLATE/parameters/os_family/Debian.yaml

@@ -2,14 +2,26 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os_family') == Debian.
-# You just need to add the key:values for an `os_family` that differ
+# You just need to add the key:values for this `os_family` that differ
 # from `defaults.yaml` + `<osarch>.yaml`.
 #
-# If you do not need to provide defaults via the `os_family` grain,
+# 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:
     name: TEMPLATE-debian
   config: /etc/TEMPLATE.d/custom.conf
+
+...

TEMPLATE/parameters/os_family/FreeBSD.yaml

@@ -2,12 +2,24 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os_family') == FreeBSD.
-# You just need to add the key:values for an `os_family` that differ
+# You just need to add the key:values for this `os_family` that differ
 # from `defaults.yaml` + `<osarch>.yaml`.
 #
-# If you do not need to provide defaults via the `os_family` grain,
+# 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
+
+...

TEMPLATE/parameters/os_family/Gentoo.yaml

@@ -2,11 +2,22 @@
 # vim: ft=yaml
 #
 # Setup variables specific to salt['config.get']('os_family') == Gentoo.
-# You just need to add the key:values for an `os_family` that differ
+# You just need to add the key:values for this `os_family` that differ
 # from `defaults.yaml` + `<osarch>.yaml`.
 #
-# If you do not need to provide defaults via the `os_family` grain,
+# 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: {}
+...