Bitnami/charts
2
0
Fork 0
mirror of https://github.com/bitnami/charts.git synced 2026-04-02 07:17:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update readme-generator links (#21043)

Browse Source 
* Update readme-generator links

Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>

* Update main files

Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>

---------

Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>
This commit is contained in:
Carlos Rodríguez Hernández
2023-11-17 21:41:49 +01:00
committed by GitHub
parent 186d565d00
commit 1581eba804
12 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -36,6 +36,6 @@
<!-- [Place an '[X]' (no spaces) in all applicable fields. Please remove unrelated fields.] -->
- [ ] Chart version bumped in `Chart.yaml` according to [semver](http://semver.org/). This is *not necessary* when the changes only affect README.md files.
- [ ] Variables are documented in the values.yaml and added to the `README.md` using [readme-generator-for-helm](https://github.com/bitnami-labs/readme-generator-for-helm)
- [ ] Variables are documented in the values.yaml and added to the `README.md` using [readme-generator-for-helm](https://github.com/bitnami/readme-generator-for-helm)
- [ ] Title of the pull request follows this pattern [bitnami/<name_of_the_chart>] Descriptive title
- [ ] All commits signed off and in agreement of [Developer Certificate of Origin (DCO)](https://github.com/bitnami/charts/blob/main/CONTRIBUTING.md#sign-your-work)

2
CONTRIBUTING.md
View File

@@ -56,7 +56,7 @@ Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will
### Documentation Requirements
- A chart's `README.md` must include configuration options. The tables of parameters are generated based on the metadata information from the `values.yaml` file, by using [this tool](https://github.com/bitnami-labs/readme-generator-for-helm).
- A chart's `README.md` must include configuration options. The tables of parameters are generated based on the metadata information from the `values.yaml` file, by using [this tool](https://github.com/bitnami/readme-generator-for-helm).
- A chart's `NOTES.txt` must include relevant post-installation information.
- The title of the PR starts with chart name (e.g. `[bitnami/chart]`)

2
bitnami/argo-workflows/README.md
View File

@@ -375,7 +375,7 @@ The command removes all the Kubernetes components associated with the chart and
| `externalDatabase.existingSecret` | The name of an existing secret with database credentials | `""` |
| `externalDatabase.type` | Either postgresql or mysql | `""` |
See <https://github.com/bitnami-labs/readme-generator-for-helm> to create the table
See <https://github.com/bitnami/readme-generator-for-helm> to create the table
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,

2
bitnami/clickhouse/README.md
View File

@@ -353,7 +353,7 @@ The command removes all the Kubernetes components associated with the chart and
| `zookeeper.image.repository` | Zookeeper image repository | `REPOSITORY_NAME/zookeeper` |
| `zookeeper.image.pullPolicy` | Zookeeper image pull policy | `IfNotPresent` |
See <https://github.com/bitnami-labs/readme-generator-for-helm> to create the table.
See <https://github.com/bitnami/readme-generator-for-helm> to create the table.
The above parameters map to the env variables defined in [bitnami/clickhouse](https://github.com/bitnami/containers/tree/main/bitnami/clickhouse). For more information please refer to the [bitnami/clickhouse](https://github.com/bitnami/containers/tree/main/bitnami/clickhouse) image documentation.

2
bitnami/concourse/README.md
View File

@@ -389,7 +389,7 @@ The command removes all the Kubernetes components associated with the chart and
| `externalDatabase.existingSecret` | Name of an existing secret resource containing the database credentials | `""` |
| `externalDatabase.existingSecretPasswordKey` | Name of an existing secret key containing the database credentials | `""` |
See <https://github.com/bitnami-labs/readme-generator-for-helm> to create the table.
See <https://github.com/bitnami/readme-generator-for-helm> to create the table.
The above parameters map to the env variables defined in [bitnami/concourse](https://github.com/bitnami/containers/tree/main/bitnami/concourse). For more information please refer to the [bitnami/concourse](https://github.com/bitnami/containers/tree/main/bitnami/concourse) image documentation.

2
bitnami/grafana-loki/README.md
View File

@@ -1172,7 +1172,7 @@ The command removes all the Kubernetes components associated with the chart and
| `memcachedindexwrites.nameOverride` | override the subchart name | `""` |
| `memcachedindexwrites.service.ports.memcached` | Memcached service port | `11211` |
See <https://github.com/bitnami-labs/readme-generator-for-helm> to create the table.
See <https://github.com/bitnami/readme-generator-for-helm> to create the table.
The above parameters map to the env variables defined in [bitnami/grafana-loki](https://github.com/bitnami/containers/tree/main/bitnami/grafana-loki). For more information please refer to the [bitnami/grafana-loki](https://github.com/bitnami/containers/tree/main/bitnami/grafana-loki) image documentation.

2
bitnami/grafana-mimir/README.md
View File

@@ -1270,7 +1270,7 @@ The command removes all the Kubernetes components associated with the chart and
| `memcachedmetadata.nameOverride` | override the subchart name | `""` |
| `memcachedmetadata.service.ports.memcached` | Memcached service port | `11211` |
See <https://github.com/bitnami-labs/readme-generator-for-helm> to create the table
See <https://github.com/bitnami/readme-generator-for-helm> to create the table
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,

2
bitnami/milvus/README.md
View File

@@ -1493,7 +1493,7 @@ The command removes all the Kubernetes components associated with the chart and
| `kafka.sasl.enabledMechanisms` | Kafka enabled SASL mechanisms | `PLAIN` |
| `kafka.sasl.client.users` | Kafka client users | `["user"]` |
See <https://github.com/bitnami-labs/readme-generator-for-helm> to create the table.
See <https://github.com/bitnami/readme-generator-for-helm> to create the table.
The above parameters map to the env variables defined in [bitnami/milvus](https://github.com/bitnami/containers/tree/main/bitnami/milvus). For more information please refer to the [bitnami/milvus](https://github.com/bitnami/containers/tree/main/bitnami/milvus) image documentation.

2
bitnami/oauth2-proxy/README.md
View File

@@ -250,7 +250,7 @@ The command removes all the Kubernetes components associated with the chart and
| `redis.sentinel.service.port` | Redis&reg; (with Sentinel) service port | `6379` |
| `redis.sentinel.service.sentinelPort` | Redis&reg; (with Sentinel) sentinel service port | `26379` |
See <https://github.com/bitnami-labs/readmenator> to create the table
See <https://github.com/bitnami/readme-generator-for-helm> to create the table
The above parameters map to the env variables defined in [bitnami/oauth2-proxy](https://github.com/bitnami/containers/tree/main/bitnami/oauth2-proxy). For more information please refer to the [bitnami/oauth2-proxy](https://github.com/bitnami/containers/tree/main/bitnami/oauth2-proxy) image documentation.

2
bitnami/pinniped/README.md
View File

@@ -318,7 +318,7 @@ The command removes all the Kubernetes components associated with the chart and
| `supervisor.ingress.secrets` | Custom TLS certificates as secrets | `[]` |
| `supervisor.ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` |
See <https://github.com/bitnami-labs/readme-generator-for-helm> to create the table
See <https://github.com/bitnami/readme-generator-for-helm> to create the table
The above parameters map to the env variables defined in [bitnami/pinniped](https://github.com/bitnami/containers/tree/main/bitnami/pinniped). For more information please refer to the [bitnami/pinniped](https://github.com/bitnami/containers/tree/main/bitnami/pinniped) image documentation.

2
bitnami/redis/README.md
View File

@@ -862,7 +862,7 @@ The Redis&reg; sentinel exporter was removed in this version because the upstrea
- `sentinel.metrics.*` parameters are deprecated in favor of `metrics.sentinel.*` ones.
- New parameters to add custom command, environment variables, sidecars, init containers, etc. were added.
- Chart labels were adapted to follow the [Helm charts standard labels](https://helm.sh/docs/chart_best_practices/labels/#standard-labels).
- values.yaml metadata was adapted to follow the format supported by [Readme Generator for Helm](https://github.com/bitnami-labs/readme-generator-for-helm).
- values.yaml metadata was adapted to follow the format supported by [Readme Generator for Helm](https://github.com/bitnami/readme-generator-for-helm).
Consequences:

2
template/CHART_NAME/README.md
View File

@@ -49,7 +49,7 @@ The command removes all the Kubernetes components associated with the chart and
## Parameters
See <https://github.com/bitnami-labs/readme-generator-for-helm> to create the table
See <https://github.com/bitnami/readme-generator-for-helm> to create the table
The above parameters map to the env variables defined in [bitnami/%%CHART_NAME%%](https://github.com/bitnami/containers/tree/main/bitnami/%%CHART_NAME%%). For more information please refer to the [bitnami/%%CHART_NAME%%](https://github.com/bitnami/containers/tree/main/bitnami/%%CHART_NAME%%) image documentation.