From 68aaa3437894f0740b127cbb49508f5547c447a8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Javier=20B=C3=A9rtoli?= <javier@netmanagers.com.ar>
Date: Fri, 21 Aug 2020 10:46:48 -0300
Subject: [PATCH] docs(pillar.example): add some comments

---
 pillar.example | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/pillar.example b/pillar.example
index 1da1d0b..462dc82 100644
--- a/pillar.example
+++ b/pillar.example
@@ -8,8 +8,10 @@ prometheus:
       - haskell
       - rust
     component:
+      # List components (ie, exporters) using underscores and
+      # removing the 'prometheus' prefix
       - prometheus
-      - alertmanager          # not in debian repo, only archive
+      - alertmanager
       - node_exporter
       # - memcached_exporter  # not in upstream repo, only archive
 
@@ -37,6 +39,14 @@ prometheus:
       golang:
         version: v1.6.0
     component:
+      # If you use OS packages in Debian's family, components should have
+      # a 'name' variable stating the name of the package (it's generally
+      # something like `prometheus-component-with-dashes-replacing-underscores`
+      # ie,
+      # node_exporter:
+      #   name: prometheus-node-exporter
+      #
+      # See prometheus/osfamilymap.yaml for more examples
       alertmanager:
         config:
           # yamllint disable-line rule:line-length