Skip to content

Commit

Permalink
Clean up of documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
KastTrifork committed Oct 31, 2024
1 parent 9741f31 commit b47ef20
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 24 deletions.
17 changes: 7 additions & 10 deletions charts/redpanda-console-oauth2proxy/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
// This file contains the specification for the Cheetah Redpanda Console Helm Chart.
// It provides information about the default values and descriptions of settings in the chart.// The "chart.valuesTable" template generates a table of settings and their descriptions.
// It also includes the default values for each setting.

# Cheetah Redpanda Console Helm Chart Specification
---
description: Find the default values and descriptions of settings in the Cheetah Redpanda Console Helm chart.
---

### Description:
Find the default values and descriptions of settings in the Cheetah Redpanda Console Helm chart.

![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.6.1](https://img.shields.io/badge/AppVersion-v2.6.1-informational?style=flat-square)

Expand Down Expand Up @@ -45,13 +46,6 @@ This chart uses the following settings that are specific to Cheetah Redpanda Con

See an example of how the values can be set through a release at the bottom of this readme

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

## Source Code

* <https://github.com/redpanda-data/helm-charts>

## Settings

| Key | Description | Default |
Expand Down Expand Up @@ -156,6 +150,9 @@ Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/n
| [deployment.extraArgs](https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=deployment.extraArgs) | | `[]` |
| [strategy](https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=strategy) | | `{}` |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

# An example of how to set these values and use the helm chart through a release is shown below:

```yaml
Expand Down
22 changes: 8 additions & 14 deletions charts/redpanda-console-oauth2proxy/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@

{{- define "chart.header" -}}
# Cheetah Redpanda Console Helm Chart Specification
---
description: Find the default values and descriptions of settings in the Cheetah Redpanda Console Helm chart.
---

### Description:
Find the default values and descriptions of settings in the Cheetah Redpanda Console Helm chart.
{{ "\n" -}}
{{- end -}}


{{ define "chart.description" -}}

Disclaimer - This chart is an extension of the official Cheetah Redpanda Console Helm Chart.
Expand Down Expand Up @@ -50,6 +52,7 @@ See an example of how the values can be set through a release at the bottom of t

// The "chart.valuesTable" template generates a table of settings and their descriptions.
// It also includes the default values for each setting.

{{ define "chart.valuesTable" }}

## Settings
Expand All @@ -64,22 +67,13 @@ See an example of how the values can be set through a release at the bottom of t

{{- template "chart.header" . -}}

{{ template "chart.deprecationWarning" . }}

{{ template "chart.badgesSection" . }}
{{ "\n" }}{{ template "chart.badgesSection" . }}{{ "\n" }}

{{ template "chart.description" . }}

{{ template "helm-docs.versionFooter" . }}

{{ template "chart.homepageLine" . }}

{{ template "chart.sourcesSection" . }}

{{ template "chart.requirementsSection" . }}

{{ template "chart.valuesTable" . }}

{{ template "helm-docs.versionFooter" . }}


# An example of how to set these values and use the helm chart through a release is shown below:
Expand Down

0 comments on commit b47ef20

Please sign in to comment.