From 316b9b236b4e39b7f2bc06dda662f5f8bf6f0975 Mon Sep 17 00:00:00 2001
From: Markus Pesch <markus.pesch@cryptic.systems>
Date: Tue, 3 Dec 2024 09:39:04 +0100
Subject: [PATCH] doc(README): apply proper names

---
 .markdownlint.yaml |  1 +
 README.md          |  2 +-
 values.yaml        | 10 +++++-----
 3 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/.markdownlint.yaml b/.markdownlint.yaml
index e21a6a4..5156987 100644
--- a/.markdownlint.yaml
+++ b/.markdownlint.yaml
@@ -139,6 +139,7 @@ MD044:
     - ORBIS U
     - PostgreSQL
     - Prometheus
+    - prometheus-exporter
     - SSL
     - TLS
   # Include code blocks
diff --git a/README.md b/README.md
index 50ca034..0aad8c9 100644
--- a/README.md
+++ b/README.md
@@ -224,7 +224,7 @@ deployment:
 | `deployment.terminationGracePeriodSeconds`         | How long to wait until forcefully kill the pod.                                                            | `60`                                    |
 | `deployment.tolerations`                           | Tolerations of the postgres-exporter deployment.                                                           | `[]`                                    |
 | `deployment.topologySpreadConstraints`             | TopologySpreadConstraints of the postgres-exporter deployment.                                             | `[]`                                    |
-| `deployment.volumes`                               | Additional volumes to mount into the pods of the Prometheus-exporter deployment.                           | `[]`                                    |
+| `deployment.volumes`                               | Additional volumes to mount into the pods of the prometheus-exporter deployment.                           | `[]`                                    |
 
 ### Grafana
 
diff --git a/values.yaml b/values.yaml
index 0227441..743348a 100644
--- a/values.yaml
+++ b/values.yaml
@@ -248,7 +248,7 @@ deployment:
   #     secretName: my-secret
 
 ## @section Grafana
-## @param grafana.enabled Enable integration into Grafana. Require the prometheus operator deployment.
+## @param grafana.enabled Enable integration into Grafana. Require the Prometheus operator deployment.
 grafana:
   enabled: false
 
@@ -315,7 +315,7 @@ prometheus:
     ## @param prometheus.metrics.podMonitor.honorLabels Honor labels.
     ## @param prometheus.metrics.podMonitor.labels Additional podMonitor labels.
     ## @param prometheus.metrics.podMonitor.interval Interval at which metrics should be scraped. If not specified Prometheus' global scrape interval is used.
-    ## @param prometheus.metrics.podMonitor.path HTTP path for scraping prometheus metrics.
+    ## @param prometheus.metrics.podMonitor.path HTTP path for scraping Prometheus metrics.
     ## @param prometheus.metrics.podMonitor.relabelings RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields.
     ## @param prometheus.metrics.podMonitor.scrapeTimeout Timeout after which the scrape is ended. If not specified, global Prometheus scrape timeout is used.
     ## @param prometheus.metrics.podMonitor.scheme HTTP scheme to use for scraping. For example `http` or `https`.
@@ -342,7 +342,7 @@ prometheus:
     ## @param prometheus.metrics.serviceMonitor.followRedirects FollowRedirects configures whether scrape requests follow HTTP 3xx redirects.
     ## @param prometheus.metrics.serviceMonitor.honorLabels Honor labels.
     ## @param prometheus.metrics.serviceMonitor.interval Interval at which metrics should be scraped. If not specified Prometheus' global scrape interval is used.
-    ## @param prometheus.metrics.serviceMonitor.path HTTP path for scraping prometheus metrics.
+    ## @param prometheus.metrics.serviceMonitor.path HTTP path for scraping Prometheus metrics.
     ## @param prometheus.metrics.serviceMonitor.relabelings RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields.
     ## @param prometheus.metrics.serviceMonitor.scrapeTimeout Timeout after which the scrape is ended. If not specified, global Prometheus scrape timeout is used.
     ## @param prometheus.metrics.serviceMonitor.scheme HTTP scheme to use for scraping. For example `http` or `https`.
@@ -362,8 +362,8 @@ prometheus:
       scheme: "http"
       tlsConfig: {}
 
-  ## @param prometheus.rules Array of prometheus rules for monitoring the application and triggering alerts.
-  ## @skip prometheus.rules Skip individual prometheus rules.
+  ## @param prometheus.rules Array of Prometheus rules for monitoring the application and triggering alerts.
+  ## @skip prometheus.rules Skip individual Prometheus rules.
   rules: []
   # - alert: ExporterErrors
   #   expr: pg_exporter_last_scrape_error == 1