Cleanup documentation

Signed-off-by: Marco Franssen <[email protected]>
2023-11-08 13:11:58 +01:00
parent 37cd9f25e2
commit 0320c3f755
25 changed files with 130 additions and 300 deletions
@@ -1,14 +1,13 @@
 # spiffe-csi-driver

-<!-- This README.md is generated. Please edit README.md.gotmpl -->
-
 ![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.2.3](https://img.shields.io/badge/AppVersion-0.2.3-informational?style=flat-square)

 A Helm chart to install the SPIFFE CSI driver.

 **Homepage:** <https://github.com/spiffe/helm-charts/tree/main/charts/spire>

-> **Note**: The recommended version is `0.2.3` to support arm64 nodes. If running with any
+> [!Note]
+> The recommended version is `0.2.3` to support arm64 nodes. If running with any
 > prior version to `0.2.3` you have to use a `nodeSelector` to limit to `kubernetes.io/arch: amd64`.

 ## Maintainers
@@ -24,6 +23,8 @@ A Helm chart to install the SPIFFE CSI driver.

 * <https://github.com/spiffe/helm-charts/tree/main/charts/spire>

+<!-- The parameters section is generated using helm-docs.sh and should not be edited by hand. -->
+
 ## Parameters

 ### SPIFFE CSI Driver Chart parameters
@@ -1,24 +0,0 @@
-{{ template "chart.header" . }}
-
-<!-- This README.md is generated. Please edit README.md.gotmpl -->
-
-{{ template "chart.deprecationWarning" . }}
-
-{{ template "chart.badgesSection" . }}
-
-{{ template "chart.description" . }}
-
-{{ template "chart.homepageLine" . }}
-
-> **Note**: The recommended version is `0.2.3` to support arm64 nodes. If running with any
-> prior version to `0.2.3` you have to use a `nodeSelector` to limit to `kubernetes.io/arch: amd64`.
-
-{{ template "chart.maintainersSection" . }}
-
-{{ template "chart.sourcesSection" . }}
-
-{{ template "chart.requirementsSection" . }}
-
-{{ template "chart.valuesSection" . }}
-
----------------------------------------------