Improve HelmApp docs

bakdata · Oct 12, 2023 · 579edcd · 579edcd
1 parent c5042b2
commit 579edcd
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 9 deletions.
diff --git a/docs/docs/resources/pipeline-components/headers/helm-app.yaml b/docs/docs/resources/pipeline-components/headers/helm-app.yaml
@@ -1,3 +1,3 @@
-# Kubernetes apps managed through Helm with an associated Helm chart
+# Kubernetes app managed through Helm with an associated Helm chart
 - type: helm-app
   name: helm-app # required
diff --git a/docs/docs/resources/pipeline-components/helm-app.yaml b/docs/docs/resources/pipeline-components/helm-app.yaml
@@ -1,4 +1,4 @@
-# Kubernetes apps managed through Helm with an associated Helm chart
+# Kubernetes app managed through Helm with an associated Helm chart
 - type: helm-app
   name: helm-app # required
   # Pipeline prefix that will prefix every component name. If you wish to not

diff --git a/docs/docs/resources/pipeline-components/pipeline.yaml b/docs/docs/resources/pipeline-components/pipeline.yaml
@@ -1,4 +1,4 @@
-# Kubernetes apps managed through Helm with an associated Helm chart
+# Kubernetes app managed through Helm with an associated Helm chart
 - type: helm-app
   name: helm-app # required
   # Pipeline prefix that will prefix every component name. If you wish to not

diff --git a/docs/docs/resources/pipeline-defaults/defaults-helm-app.yaml b/docs/docs/resources/pipeline-defaults/defaults-helm-app.yaml
@@ -1,4 +1,4 @@
-# Kubernetes apps managed through Helm with an associated Helm chart
+# Kubernetes app managed through Helm with an associated Helm chart
 #
 # Parent of: KafkaApp
 # Child of: KubernetesApp

diff --git a/docs/docs/resources/pipeline-defaults/defaults.yaml b/docs/docs/resources/pipeline-defaults/defaults.yaml
@@ -1,4 +1,4 @@
-# Kubernetes apps managed through Helm with an associated Helm chart
+# Kubernetes app managed through Helm with an associated Helm chart
 #
 # Parent of: KafkaApp
 # Child of: KubernetesApp

diff --git a/docs/docs/resources/pipeline-defaults/headers/defaults-helm-app.yaml b/docs/docs/resources/pipeline-defaults/headers/defaults-helm-app.yaml
@@ -1,4 +1,4 @@
-# Kubernetes apps managed through Helm with an associated Helm chart
+# Kubernetes app managed through Helm with an associated Helm chart
 #
 # Parent of: KafkaApp
 # Child of: KubernetesApp

diff --git a/docs/docs/schema/pipeline.json b/docs/docs/schema/pipeline.json
@@ -48,7 +48,7 @@
             "type": "object"
         },
         "HelmApp": {
-            "description": "Kubernetes apps managed through Helm with an associated Helm chart.",
+            "description": "Kubernetes app managed through Helm with an associated Helm chart.",
             "properties": {
                 "app": {
                     "allOf": [
@@ -104,7 +104,7 @@
                 },
                 "type": {
                     "default": "helm-app",
-                    "description": "Kubernetes apps managed through Helm with an associated Helm chart.",
+                    "description": "Kubernetes app managed through Helm with an associated Helm chart.",
                     "enum": [
                         "helm-app"
                     ],

diff --git a/kpops/components/base_components/helm_app.py b/kpops/components/base_components/helm_app.py
@@ -24,7 +24,7 @@
 
 
 class HelmApp(KubernetesApp):
-    """Kubernetes apps managed through Helm with an associated Helm chart.
+    """Kubernetes app managed through Helm with an associated Helm chart.
 
     :param repo_config: Configuration of the Helm chart repo to be used for
         deploying the component, defaults to None this means that the command "helm repo add" is not called and Helm