From 4b2ea47af6c0045d5e860de01bf32e2756d20342 Mon Sep 17 00:00:00 2001
From: Stavros kois <s.kois@outlook.com>
Date: Fri, 18 Nov 2022 16:41:50 +0200
Subject: [PATCH] moar docs

---
 library/common/1.0.0/values.yaml              |  21 ---
 library/common/_docs/Values.yaml Explained.md | 141 +++++++++++++++++-
 2 files changed, 140 insertions(+), 22 deletions(-)

diff --git a/library/common/1.0.0/values.yaml b/library/common/1.0.0/values.yaml
index 00faa43f3c..f29e604291 100644
--- a/library/common/1.0.0/values.yaml
+++ b/library/common/1.0.0/values.yaml
@@ -86,32 +86,11 @@ security:
   PUID: 568
   UMASK: 002
 
-# -- Main environment variables. Helm Template enabled.
-# Syntax options:
-# A) TZ: UTC
-# B) ENV_VAR: "{{ .Release.Name }}"
-# C) ENV_VAR:
-#      configMapKeyRef | secretKeyRef:
-#        name: object-name | "{{ .Values.objectName }}"
-#        key: key-name | "{{ .Values.some_key }}"
-#        optional: false (ony with secretKeyRef)
 env: {}
-  # some_env: some_value
-  # some_env2: some_value2
 
-# -- Mainly used in the SCALE UI. Helm Template enabled.
 envList: []
-  # - name: SOME_ENV_VAR
-  #   value: SOME_VALUE
-  # - name: SOME_ENV_VAR2
-  #   value: SOME_VALUE2
 
-# Load envs from secret or configMap. Helm template enabled.
 envFrom: []
-#   - configMapRef:
-#       name: config-map-name
-#   - secretRef:
-#       name: secret-name
 
 controller:
   # -- Enable the controller.
diff --git a/library/common/_docs/Values.yaml Explained.md b/library/common/_docs/Values.yaml Explained.md
index 75ba1aee4c..b72e3c420b 100644
--- a/library/common/_docs/Values.yaml Explained.md	
+++ b/library/common/_docs/Values.yaml Explained.md	
@@ -819,6 +819,8 @@ TZ: UTC
 TZ: "{{ .Values.some_key }}"
 ```
 
+Sets it to:
+
 - Deployment
   - spec.template.spec.containers[0].env[TZ]
 
@@ -860,6 +862,8 @@ security:
   PUID: "{{ .Values.some_key }}"
 ```
 
+Sets it to:
+
 - Deployment
   - spec.template.spec.containers[0].env[PUID]
   - spec.template.spec.containers[0].env[USER_ID]
@@ -888,10 +892,145 @@ security:
   UMASK: "{{ .Values.some_key }}"
 ```
 
+Sets it to:
+
 - Deployment
   - spec.template.spec.containers[0].env[UMASK]
   - spec.template.spec.containers[0].env[UMASK_SET]
 
 </details>
-
 </details> <!-- End of security -->
+
+## env
+
+Sets env to the main container
+
+<details>
+<summary>Show / Hide</summary>
+
+- Type: `dict`
+- Default: `{}`
+- Helm Template: ✅
+
+Examples: Values.yaml
+
+```yaml
+env:
+  ENV_VAR: value
+
+env:
+  ENV_VAR: "{{ .Values.some.key }}"
+
+env:
+  ENV_VAR:
+    configMapKeyRef:
+      name: configmap-name
+      key: confimap-key
+
+env:
+  ENV_VAR:
+    configMapKeyRef:
+      name: "{{ .Values.some.confimap.name }}"
+      key: "{{ .Values.some.confimap.key }}"
+
+env:
+  ENV_VAR:
+    secretKeyRef:
+      name: secret-name
+      key: secret-key
+
+env:
+  ENV_VAR:
+    secretKeyRef:
+      name: "{{ .Values.some.secret.name }}"
+      key: "{{ .Values.some.secret.key }}"
+
+env:
+  ENV_VAR:
+    secretKeyRef:
+      name: secret-name
+      key: secret-key
+      optional: false
+
+env:
+  ENV_VAR:
+    secretKeyRef:
+      name: "{{ .Values.some.secret.name }}"
+      key: "{{ .Values.some.secret.key }}"
+      optional: false
+```
+
+Sets each key in the dict to:
+
+- Deployment
+  - spec.template.spec.containers[0].env[ENV_VAR]
+
+</details>
+
+## envList
+
+Sets env to the main container
+
+<details>
+<summary>Show / Hide</summary>
+
+- Type: `list`
+- Default: `[]`
+- Helm Template: ✅
+
+Examples: Values.yaml
+
+```yaml
+envList:
+  - name: ENV_VAR
+    value: value
+
+envList:
+  - name: "{{ .Values.some.name }}"
+    value: "{{ .Values.some.value }}"
+```
+
+Appends the list to:
+
+- Deployment
+  - spec.template.spec.containers[0].env
+
+</details>
+
+## envFrom
+
+Load envs from secret or configMap.
+
+<details>
+<summary>Show / Hide</summary>
+
+- Type: `list`
+- Default: `[]`
+- Helm Template: ✅
+
+Examples: Values.yaml
+
+```yaml
+envFrom:
+  - configMapRef:
+      name: configmap-name
+
+envFrom:
+  - configMapRef:
+      name: "{{ .Values.some.name }}"
+
+envFrom:
+  - secretRef:
+      name: secret-name
+
+envFrom:
+  - secretRef:
+      name: "{{ .Values.some.name }}"
+```
+
+Appends the list to:
+
+- Deployment
+  - spec.template.spec.containers[0].envFrom
+
+</details>