Improve comments and examples in osfamilymap & osmap

saltstack-formulas · Feb 12, 2019 · b5c4987 · b5c4987
1 parent d7940c0
commit b5c4987
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/template/osfamilymap.yaml b/template/osfamilymap.yaml
@@ -2,7 +2,10 @@
 # vim: ft=yaml
 #
 # Setup variables using grains['os_family'] based logic.
-# Only add key:values that differ from `defaults.yaml`.
+# You just need to add the key:values for an `os_family` that differ
+# from `defaults.yaml`.
+# Only add an `os_family` which is/will be supported by the formula
+# (empty `os_family`s do not need to be listed, just added here as an example).
 ---
 Debian:
   pkg: template-debian
@@ -19,6 +22,8 @@ Gentoo: {}
 
 Arch:
   pkg: template-arch
+  service:
+    name: service-arch
 
 Alpine: {}
 

diff --git a/template/osmap.yaml b/template/osmap.yaml
@@ -2,13 +2,19 @@
 # vim: ft=yaml
 #
 # Setup variables using grains['os'] based logic.
-# Only add key:values that differ from `defaults.yaml` + `os_family.yaml`.
+# You just need to add the key:values for an `os` that differ
+# from `defaults.yaml` + `os_family.yaml`.
+# Only add an `os` which is/will be supported by the formula
+# (empty `os`es do not need to be listed, just added here as an example).
 ---
 Ubuntu:
   pkg: template-ubuntu
+  config: /etc/template.d/custom-ubuntu.conf
 
 Fedora:
   pkg: template-fedora
+  service:
+    name: service-fedora
 
 Raspbian: {}