From 87b3b5b9075090fc0e2c5c40cb15b0b2c5bbb513 Mon Sep 17 00:00:00 2001
From: Pete Birley <pete@port.direct>
Date: Mon, 9 Jul 2018 15:15:00 -0500
Subject: [PATCH] Helm-Toolkit: Add basic documentation for the metadata labels
 function

This PS adds basic documentation for the metadata labels function.

Change-Id: I8ef3093aafabb64c61396a721b6c6b66dc5de9e8
Signed-off-by: Pete Birley <pete@port.direct>
---
 .../snippets/_kubernetes_metadata_labels.tpl        | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/helm-toolkit/templates/snippets/_kubernetes_metadata_labels.tpl b/helm-toolkit/templates/snippets/_kubernetes_metadata_labels.tpl
index 19d32ab4e..f67bfaf28 100644
--- a/helm-toolkit/templates/snippets/_kubernetes_metadata_labels.tpl
+++ b/helm-toolkit/templates/snippets/_kubernetes_metadata_labels.tpl
@@ -14,6 +14,19 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */}}
 
+{{/*
+abstract: |
+  Renders a set of standardised labels
+values: |
+  release_group: null
+usage: |
+  {{ tuple . "foo" "bar" | include "helm-toolkit.snippets.kubernetes_metadata_labels" }}
+return: |
+  release_group: RELEASE-NAME
+  application: foo
+  component: bar
+*/}}
+
 {{- define "helm-toolkit.snippets.kubernetes_metadata_labels" -}}
 {{- $envAll := index . 0 -}}
 {{- $application := index . 1 -}}