docs: add values.yaml descriptions to README.md

charts/kor/Chart.yaml

@@ -1,24 +1,6 @@
 apiVersion: v2
 name: kor
-description: A Helm chart for Kubernetes
-
-# A chart can be either an 'application' or a 'library' chart.
-#
-# Application charts are a collection of templates that can be packaged into versioned archives
-# to be deployed.
-#
-# Library charts provide useful utilities or functions for the chart developer. They're included as
-# a dependency of application charts to inject those utilities and functions into the rendering
-# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+description: A Kubernetes Helm Chart to discover orphaned resources using kor
 type: application
-
-# This is the chart version. This version number should be incremented each time you make changes
-# to the chart and its templates, including the app version.
-# Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.5
-
-# This is the version number of the application being deployed. This version number should be
-# incremented each time you make changes to the application. Versions are not expected to
-# follow Semantic Versioning. They should reflect the version the application is using.
-# It is recommended to use it with quotes.
+version: 0.1.6
 appVersion: "0.4.0"

charts/kor/README.md

@@ -1,14 +1,14 @@
 # kor
 
-![Version: 0.1.5](https://img.shields.io/badge/Version-0.1.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.4.0](https://img.shields.io/badge/AppVersion-0.4.0-informational?style=flat-square)
+![Version: 0.1.6](https://img.shields.io/badge/Version-0.1.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.4.0](https://img.shields.io/badge/AppVersion-0.4.0-informational?style=flat-square)
 
-A Helm chart for Kubernetes
+A Kubernetes Helm Chart to discover orphaned resources using kor
 
 ## Values
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| additionalLabels | object | `{}` |  |
+| additionalLabels | object | `{}` | Custom labels to add into metadata |
 | cronJob.args[0] | string | `"all"` |  |
 | cronJob.command[0] | string | `"kor"` |  |
 | cronJob.enabled | bool | `false` |  |
@@ -42,17 +42,17 @@ A Helm chart for Kubernetes
 | prometheusExporter.service.port | int | `8080` |  |
 | prometheusExporter.service.type | string | `"ClusterIP"` |  |
 | prometheusExporter.serviceMonitor.enabled | bool | `true` |  |
-| prometheusExporter.serviceMonitor.interval | string | `"30s"` |  |
-| prometheusExporter.serviceMonitor.labels | object | `{}` |  |
+| prometheusExporter.serviceMonitor.interval | string | `"30s"` | Set how frequently Prometheus should scrape |
+| prometheusExporter.serviceMonitor.labels | object | `{}` | Service monitor labels |
 | prometheusExporter.serviceMonitor.metricRelabelings | list | `[]` |  |
-| prometheusExporter.serviceMonitor.namespace | string | `""` |  |
+| prometheusExporter.serviceMonitor.namespace | string | `""` | Set the namespace the ServiceMonitor should be deployed, if empty namespace will be `.Release.Namespace` |
 | prometheusExporter.serviceMonitor.relabelings | list | `[]` |  |
-| prometheusExporter.serviceMonitor.targetLabels | list | `[]` |  |
+| prometheusExporter.serviceMonitor.targetLabels | list | `[]` | Set of labels to transfer on the Kubernetes Service onto the target. |
 | prometheusExporter.serviceMonitor.telemetryPath | string | `"/metrics"` |  |
-| prometheusExporter.serviceMonitor.timeout | string | `"10s"` |  |
-| serviceAccount.annotations | object | `{}` |  |
-| serviceAccount.create | bool | `true` |  |
-| serviceAccount.name | string | `""` |  |
+| prometheusExporter.serviceMonitor.timeout | string | `"10s"` | Set timeout for scrape |
+| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
+| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
+| serviceAccount.name | string | `""` | If not set and create is true, a name is generated using the fullname template |
 
 ----------------------------------------------
 Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)

charts/kor/values.yaml

@@ -61,28 +61,28 @@ prometheusExporter:
 
   serviceMonitor:
     enabled: true
-    # Set the namespace the ServiceMonitor should be deployed, if empty namespace will be .Release.Namespace
+    # -- Set the namespace the ServiceMonitor should be deployed, if empty namespace will be `.Release.Namespace`
     namespace: ""
-    # Service monitor labels
+    # -- Service monitor labels
     labels: {}
-    # Set how frequently Prometheus should scrape
+    # -- Set how frequently Prometheus should scrape
     interval: 30s
     telemetryPath: /metrics
-    # Set timeout for scrape
+    # -- Set timeout for scrape
     timeout: 10s
     relabelings: []
-    # Set of labels to transfer on the Kubernetes Service onto the target.
+    # -- Set of labels to transfer on the Kubernetes Service onto the target.
     targetLabels: []
     metricRelabelings: []
 
-# Custom labels to add into metadata
+# -- Custom labels to add into metadata
 additionalLabels: {}
 
 serviceAccount:
-  # Specifies whether a service account should be created
+  # -- Specifies whether a service account should be created
   create: true
-  # Annotations to add to the service account
+  # -- Annotations to add to the service account
   annotations: {}
-  # The name of the service account to use.
-  # If not set and create is true, a name is generated using the fullname template
+  # -- The name of the service account to use.
+  # -- If not set and create is true, a name is generated using the fullname template
   name: ""