From 74eaa91dab7b9b31c751458d6062999b369df828 Mon Sep 17 00:00:00 2001
From: lvlcn-t <75443136+lvlcn-t@users.noreply.github.com>
Date: Fri, 19 Jan 2024 22:17:07 +0100
Subject: [PATCH] docs: typos & rephrasing chart value docu

---
 chart/README.md   | 6 +++---
 chart/values.yaml | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/chart/README.md b/chart/README.md
index f055c30c..86590609 100644
--- a/chart/README.md
+++ b/chart/README.md
@@ -20,10 +20,10 @@ A Helm chart to install Sparrow
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | affinity | object | `{}` |  |
-| checksConfig | object | `{"checks":{}}` | runtime configuration of the Sparrow see: https://github.com/caas-team/sparrow?tab=readme-ov-file#runtime |
+| checksConfig | object | `{"checks":{}}` | Check configuration of the Sparrow read on runtime see: https://github.com/caas-team/sparrow?tab=readme-ov-file#runtime |
 | env | object | `{}` |  |
 | envFromSecrets | list | `[]` | extra environment variables Allows you to set environment variables through secrets you defined outside of the helm chart Useful for sensitive information like the http loader token |
-| extraArgs | object | `{}` | extra command line start parameters see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md |
+| extraArgs | object | `{}` | Extra command line start parameters see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md |
 | fullnameOverride | string | `""` |  |
 | image.pullPolicy | string | `"IfNotPresent"` |  |
 | image.repository | string | `"ghcr.io/caas-team/sparrow"` |  |
@@ -62,6 +62,6 @@ A Helm chart to install Sparrow
 | serviceMonitor.interval | string | `"30s"` | Sets the scrape interval |
 | serviceMonitor.labels | object | `{}` | Additional label added to the service Monitor |
 | serviceMonitor.scrapeTimeout | string | `"5s"` | Sets the scrape timeout |
-| sparrowConfig | object | `{"loader":{"path":"/config/checksConfig.yaml","type":"file"},"name":"sparrow.com"}` | startup configuration of the Sparrow see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md |
+| sparrowConfig | object | `{"loader":{"path":"/config/checksConfig.yaml","type":"file"},"name":"sparrow.com"}` | Sparrow configuration read on startup see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md |
 | tolerations | list | `[]` |  |
 
diff --git a/chart/values.yaml b/chart/values.yaml
index 9fed8645..cb087210 100644
--- a/chart/values.yaml
+++ b/chart/values.yaml
@@ -91,7 +91,7 @@ tolerations: []
 
 affinity: {}
 
-# -- extra command line start parameters
+# -- Extra command line start parameters
 # see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md
 extraArgs: {}
 
@@ -105,7 +105,7 @@ envFromSecrets:
   #     secretName: sparrow-auth
   #     key: SPARROW_LOADER_HTTP_TOKEN
 
-# -- startup configuration of the Sparrow
+# -- Sparrow configuration read on startup
 # see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md
 sparrowConfig:
   name: sparrow.com
@@ -135,7 +135,7 @@ sparrowConfig:
 #     baseUrl: https://gitlab.com
 #     projectId: ""
 
-# -- runtime configuration of the Sparrow
+# -- Check configuration of the Sparrow read on runtime
 # see: https://github.com/caas-team/sparrow?tab=readme-ov-file#runtime
 checksConfig:
   checks: {}