fix readme template (#82)

ricardo-ch · Aug 3, 2023 · e198885 · e198885
1 parent 9bd44b6
commit e198885
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 12 deletions.
diff --git a/charts/kafka-proxy/Chart.yaml b/charts/kafka-proxy/Chart.yaml
@@ -1,8 +1,9 @@
 apiVersion: v2
 name: kafka-proxy
-version: 0.2.10
+version: 0.2.11
 appVersion: 0.3.6
-description: Deploying the grepplabs kafka-proxy as a StatefulSet with a GKE LoadBalancer
+description: This chart installs [kafka-proxy](https://github.com/grepplabs/kafka-proxy). The Kafka Proxy is based on the idea of Cloud SQL Proxy. It allows a service to connect to Kafka brokers without having to deal with SASL/PLAIN authentication and SSL certificates.
+
 home: https://github.com/grepplabs/kafka-proxy
 sources:
   - https://github.com/grepplabs/kafka-proxy
@@ -14,7 +15,7 @@ keywords:
   - kafka-proxy
 annotations:
   artifacthub.io/changes: |
-    - "[internal] New Build Process"
+    - "fix readme title"
   artifacthub.io/images: |
     - name: kafka-proxy
       image: grepplabs/kafka-proxy:0.3.6
diff --git a/charts/kafka-proxy/README.md b/charts/kafka-proxy/README.md
@@ -1,10 +1,8 @@
-# PromLens
+# kafka-proxy
 
-![Version: 0.2.10](https://img.shields.io/badge/Version-0.2.10-informational?style=flat-square) ![AppVersion: 0.3.6](https://img.shields.io/badge/AppVersion-0.3.6-informational?style=flat-square) ![Release Status](https://github.com/ricardo-ch/helm-charts/workflows/Release%20Charts/badge.svg) [![License](https://img.shields.io/github/license/ricardo-ch/helm-charts)](https://github.com/ricardo-ch/helm-charts/blob/main/LICENSE)
+![Version: 0.2.11](https://img.shields.io/badge/Version-0.2.11-informational?style=flat-square) ![AppVersion: 0.3.6](https://img.shields.io/badge/AppVersion-0.3.6-informational?style=flat-square) ![Release Status](https://github.com/ricardo-ch/helm-charts/workflows/Release%20Charts/badge.svg) [![License](https://img.shields.io/github/license/ricardo-ch/helm-charts)](https://github.com/ricardo-ch/helm-charts/blob/main/LICENSE)
 
-This chart installs [kafka-proxy](https://github.com/grepplabs/kafka-proxy).
-
-The Kafka Proxy is based on the idea of Cloud SQL Proxy. It allows a service to connect to Kafka brokers without having to deal with SASL/PLAIN authentication and SSL certificates.
+This chart installs [kafka-proxy](https://github.com/grepplabs/kafka-proxy). The Kafka Proxy is based on the idea of Cloud SQL Proxy. It allows a service to connect to Kafka brokers without having to deal with SASL/PLAIN authentication and SSL certificates.
 
 ## Helm Chart
 

diff --git a/charts/kafka-proxy/README.md.gotmpl b/charts/kafka-proxy/README.md.gotmpl
@@ -1,12 +1,10 @@
-# PromLens
+# {{ template "chart.name" . }}
 
 {{ template "chart.deprecationWarning" . }}
 
 {{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}![Release Status](https://github.com/ricardo-ch/helm-charts/workflows/Release%20Charts/badge.svg) [![License](https://img.shields.io/github/license/ricardo-ch/helm-charts)](https://github.com/ricardo-ch/helm-charts/blob/main/LICENSE)
 
-This chart installs [kafka-proxy](https://github.com/grepplabs/kafka-proxy).
-
-The Kafka Proxy is based on the idea of Cloud SQL Proxy. It allows a service to connect to Kafka brokers without having to deal with SASL/PLAIN authentication and SSL certificates.
+{{ template "chart.description" . }}
 
 ## Helm Chart