From e0fa633e3ca2c7d31c137aec7eaf3aa7c3bbb308 Mon Sep 17 00:00:00 2001
From: Stavros kois <s.kois@outlook.com>
Date: Fri, 18 Nov 2022 13:28:30 +0200
Subject: [PATCH] add first docs

---
 library/common/1.0.0/values.yaml              |  7 +-
 library/common/_docs/Values.yaml Explained.md | 91 +++++++++++++++++++
 2 files changed, 95 insertions(+), 3 deletions(-)
 create mode 100644 library/common/_docs/Values.yaml Explained.md

diff --git a/library/common/1.0.0/values.yaml b/library/common/1.0.0/values.yaml
index 0006d91d7c..484e6206d9 100644
--- a/library/common/1.0.0/values.yaml
+++ b/library/common/1.0.0/values.yaml
@@ -1,9 +1,10 @@
+# This file only includes the default values that are applied.
+# All values can be overridden per chart, in their values.yaml
+# For Examples and Explanation view the "Values.yaml Explained" markdown file
+
 global:
-  # -- Sets an override for the suffix of the full name (Applies to current chart and all sub-charts)
   nameOverride: ""
-  # -- Sets additional global annotations. Helm templates can be used.
   annotations: {}
-  # -- Set additional global labels. Helm templates can be used.
   labels: {}
 
 # -- Sets an override for the suffix of the full name (Applies to current chart only)
diff --git a/library/common/_docs/Values.yaml Explained.md b/library/common/_docs/Values.yaml Explained.md
new file mode 100644
index 0000000000..6bbc5c2c84
--- /dev/null
+++ b/library/common/_docs/Values.yaml Explained.md	
@@ -0,0 +1,91 @@
+# Values.yaml Explained
+
+## global
+
+Available keys:
+
+```yaml
+global:
+  nameOverride: ""
+  annotations: {}
+  labels: {}
+```
+
+### nameOverride
+
+Sets an override for the suffix of the full name.
+(Applies to current chart and all sub-charts)
+
+- Type: `string`
+- Helm template: ❌
+
+Example: Values.yaml
+
+```yaml
+global:
+  nameOverride: something
+```
+
+Appends `something` to:
+
+- Deployment
+  - metadata.name
+  - spec.template.spec.containers[].name
+
+Sets `something` to:
+
+- Deployment
+  - metadata.app
+  - metadata.app.kubernetes.io/name
+  - spec.selector.matchLabels.app
+  - spec.selector.matchLabels.app.kubernetes.io/name
+  - spec.template.metadata.annotations.app
+  - spec.template.metadata.annotations.app
+  - spec.template.metadata.labels.app.kubernetes.io/name
+  - spec.template.metadata.labels.app.kubernetes.io/name
+
+### annotations
+
+Sets additional global annotations.
+
+- Type: `dict`
+- Helm Template: ✅
+  - On values only
+
+Example:
+
+Values.yaml
+
+```yaml
+global:
+  annotations:
+    key: value
+```
+
+Sets `key: value` to:
+
+- Deployment
+  - metadata.annotations
+
+### labels
+
+Set additional global labels. Helm templates can be used.
+
+- Type: `dict`
+- Helm Template: ✅
+  - On values only
+
+Example:
+
+Values.yaml
+
+```yaml
+global:
+  labels:
+    key: value
+```
+
+Sets `key: value` to:
+
+- Deployment
+  - metadata.labels