Merge pull request #712 from lsst-sqre/tickets/DM-34762

DM-34762: Add docs for watchNamespace and clusterName for strimzi-schema-registry

charts/strimzi-registry-operator/Chart.yaml

@@ -1,7 +1,9 @@
 apiVersion: v2
 name: strimzi-registry-operator
-version: 1.2.0
-description: Operator to create and manage Schema Registry on Strimzi
+version: 1.2.1
+description: Operator to create and manage a Confluent Schema Registry in a Strimzi-managed Kafka cluster.
+home: https://github.com/lsst-sqre/strimzi-schema-registry
 maintainers:
   - name: swnelson
+  - name: jonathansick
 appVersion: 0.4.1

charts/strimzi-registry-operator/README.md

@@ -1,19 +1,27 @@
 # strimzi-registry-operator
 
-![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)
+![Version: 1.2.1](https://img.shields.io/badge/Version-1.2.1-informational?style=flat-square) ![AppVersion: 0.4.1](https://img.shields.io/badge/AppVersion-0.4.1-informational?style=flat-square)
 
-Operator to create and manage Schema Registry on Strimzi
+Operator to create and manage a Confluent Schema Registry in a Strimzi-managed Kafka cluster.
+
+**Homepage:** <https://github.com/lsst-sqre/strimzi-schema-registry>
 
 ## Maintainers
 
 | Name | Email | Url |
 | ---- | ------ | --- |
 | swnelson |  |  |
+| jonathansick |  |  |
 
 ## Values
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
+| clusterName | string | `"alert-broker"` | Name of the Strimzi Kafka cluster |
 | image.repository | string | `"lsstsqre/strimzi-registry-operator"` | The repository for the container with the operator application |
-| image.tag | string | `"build"` | The tag of the operator container to deploy |
+| image.tag | string | `"0.4.1"` | The tag of the operator container to deploy |
+| operatorNamespace | string | `"strimzi-registry-operator"` | Namespace where the strimzi-registry-operator is deployed (TODO: set this automatically) |
+| watchNamespace | string | `"strimzi"` | Namespace where the Strimzi Kafka cluster is deployed |
 
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.8.1](https://github.com/norwoodj/helm-docs/releases/v1.8.1)

charts/strimzi-registry-operator/values.yaml

@@ -4,8 +4,12 @@ image:
   # -- The tag of the operator container to deploy
   tag: 0.4.1
 
+# -- Name of the Strimzi Kafka cluster
 clusterName: alert-broker
 
+# -- Namespace where the Strimzi Kafka cluster is deployed
 watchNamespace: strimzi
 
+# -- Namespace where the strimzi-registry-operator is deployed
+# (TODO: set this automatically)
 operatorNamespace: strimzi-registry-operator