Skip to content

Commit

Permalink
docs(map.jinja): add a proper docs/map.jinja.rst
Browse files Browse the repository at this point in the history
Remove details from the YAML parameter files.
  • Loading branch information
baby-gnu committed Feb 24, 2020
1 parent b771180 commit e59ee58
Show file tree
Hide file tree
Showing 20 changed files with 169 additions and 181 deletions.
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/os/Fedora.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/os/Ubuntu.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/os_family/Arch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/os_family/Debian.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/os_family/FreeBSD.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/os_family/OpenBSD.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/os_family/RedHat.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/os_family/Suse.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/osarch/386.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/osarch/amd64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/osarch/arm64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/osarch/armv6l.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/osarch/armv7l.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/osarch/ppc64le.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/osarch/s390x.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/osarch/x86_64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/osfinger/CentOS-6.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 0 additions & 10 deletions TEMPLATE/parameters/osfinger/Ubuntu-18.04.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------------
Expand Down
Loading

0 comments on commit e59ee58

Please sign in to comment.