Cleanup documentation

Signed-off-by: Marco Franssen <[email protected]>

CODE-OF-CONDUCT.md

@@ -1,8 +1,8 @@
-### Contributor Code of Conduct
+# Contributor Code of Conduct
 
 We follow the [CNCF Contributor Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). Additionally, we commit to the following guidelines as detailed on the [Linkerd Code of Conduct](https://github.com/linkerd/linkerd/wiki/Linkerd-code-of-conduct):
 
-### Community Guidelines
+## Community Guidelines
 
 - Our goal is to foster an inclusive and diverse community of technology enthusiasts.
 
@@ -14,6 +14,6 @@ We follow the [CNCF Contributor Code of Conduct](https://github.com/cncf/foundat
 
 - We do our best to avoid [subtle-isms](https://www.recurse.com/manual#sub-sec-social-rules): small actions that make others feel uncomfortable. If you witness a subtle-ism, you may respectfully point it out to the person publicly or privately, or you may ask a moderator to say something. Accidentally saying something biased is common, expected, and readily forgiven. It is not in and of itself a bannable offense.
 
-### Moderation
+## Moderation
 
 - If you feel any of SPIFFE's communication channels require moderation, please e-mail the [SPIFFE Steering Committee (SSC)](mailto:[email protected]).

CONTRIBUTING.md

@@ -38,7 +38,8 @@ git rebase main
 
 Our CI pipeline takes care of the majority of the testing of this Chart. Other ways for you to test are by running `make test` locally using:
 
-> **Warning**: Ensure to run the test on a dedicated k8s cluster that does not have Spire installed yet.
+> [!Warning]
+> Ensure to run the test on a dedicated k8s cluster that does not have Spire installed yet.
 
 ```shell
 make test
@@ -48,7 +49,7 @@ Another approach to testing the chart is by installing one of the examples in yo
 
 ## Generating documentation
 
-Any changes to Chart.yaml or values.yaml require an update of the README.md. This update can easily be generated using [readme-generator](https://github.com/bitnami-labs/readme-generator-for-helm).
+Any changes to Chart.yaml or values.yaml require an update of the README.md. This update can easily be generated using [readme-generator][].
 
 ```shell
 ./helm-docs.sh

FAQ.md

@@ -36,25 +36,29 @@ helm repo add spiffe https://spiffe.github.io/helm-charts-hardened
 If you uninstall the SPIRE chart before all users of the CSI driver are removed, Pods will get stuck in a terminating state waiting for the driver, that no longer is installed, to unmount the volumes for the Pod. In order to fix this, reinstall the chart and remove all affected workloads that are not part of the SPIRE helm chart itself, before attempting to remove SPIRE again.
 
 You can discover Pods that use the driver with the following command:
-```
+
+```shell
 kubectl get pods --all-namespaces -o go-template='{{range .items}}{{$nn := printf "%s %s" .metadata.namespace .metadata.name}}{{range .spec.volumes}}{{if .csi.driver}}{{if eq .csi.driver "csi.spiffe.io"}}{{printf "%s\n" $nn}}{{end}}{{end}}{{end}}{{end}}'
 ```
 
 ## Uninstall is stuck. How do I fix it?
 
 If you uninstall the SPIFFE CSI driver manually before removing the chart, Pods can still be using the driver and are unable to unmount the CSI volume.
 
-To resolve, reinstall the chart before trying to remove it again. 
+To resolve, reinstall the chart before trying to remove it again.
 
 ## The PSAT plugin is not working
 
 The chart requires `Projected Service Account Tokens` which has to be enabled on your Kubernetes API server. In most cases this is already done for you.
 
-> **Note**: This is enabled by default with newer versions as shown by the existence of:
+> [!Note]
+> This is enabled by default with newer versions as shown by the existence of:
 >
+> ```yaml
 >        - --service-account-issuer
 >        - --service-account-key-file
 >        - --service-account-signing-key-file
+> ```
 
 See [Service Account Token Volume Projection](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#serviceaccount-token-volume-projection) in the Kubernetes docs for more details.
 
@@ -64,7 +68,9 @@ command to SSH into the Docker Desktop K8s VM.
 ```bash
 docker run -it --privileged --pid=host debian nsenter -t 1 -m -u -n -i sh
 ```
+
 Then add the following to `/etc/kubernetes/manifests/kube-apiserver.yaml`
+
 ```yaml
 spec:
   containers:

README.md

@@ -14,7 +14,7 @@ A suite of [Helm Charts](https://helm.sh/docs) for standardized installations of
 ## How to install or upgrade
 
 You most likely want to do an integrated setup based on the spire chart.
-[Instructions](https://artifacthub.io/packages/helm/spiffe/spire)
+See the [Instructions](https://artifacthub.io/packages/helm/spiffe/spire).
 
 ## Contributing
 

charts/spire-crds/README.md

@@ -7,6 +7,7 @@ A Helm chart to install the SPIRE CRDS.
 **Homepage:** <https://github.com/spiffe/helm-charts/tree/main/charts/spire>
 
 ## Maintainers
+
 | Name | Email | Url |
 | ---- | ------ | --- |
 | marcofranssen | <[email protected]> | <https://marcofranssen.nl> |
@@ -16,8 +17,8 @@ A Helm chart to install the SPIRE CRDS.
 
 ## Source Code
 
-* <https://github.com/spiffe/helm-charts/tree/main/charts/spire>
+* <https://github.com/spiffe/helm-charts/tree/main/charts/spire-crds>
 
-<!-- The Parameters section is generated using helm-docs.sh -->
+<!-- The parameters section is generated using helm-docs.sh and should not be edited by hand. -->
 
 ## Parameters

charts/spire/README.md

@@ -36,7 +36,7 @@ For production installs, please see [the production example](https://github.com/
 
 The spire-crds chart has been updated. Please ensure you have upgraded spire-crds before upgrading the spire chart.
 
-The chart now supports multiple parallel installs of spire-controller-manager. Each install will handle all custom resources with a matching `className` field.  By default this is set to `Release.Namespace-Release.Name` and the controller manager will only pick up custom resources with this `className`. 
+The chart now supports multiple parallel installs of spire-controller-manager. Each install will handle all custom resources with a matching `className` field.  By default this is set to `Release.Namespace-Release.Name` and the controller manager will only pick up custom resources with this `className`.
 
 If you have not loaded any SPIRE custom resources yourself, the upgrade process will be transparent. If you have loaded your own SPIRE custom resources, set `spire-server.controllerManager.watchClassless=true` until you can update your SPIRE custom resources to have the `className` for the instance specified.
 
@@ -62,7 +62,8 @@ helm install -n spire-server spire-crds charts/spire-crds
 
 ## Version support
 
-> **Note**: This Chart is still in development and still subject to change the API (`values.yaml`).
+> [!Warning]
+> This Chart is still in development and still subject to change the API (`values.yaml`).
 > Until we reach a `1.0.0` version of the chart we can't guarantee backwards compatibility although
 > we do aim for as much stability as possible.
 
@@ -71,9 +72,11 @@ helm install -n spire-server spire-crds charts/spire-crds
 | Helm       | `3.x`              |
 | Kubernetes | `1.22+`            |
 
-> **Note**: For Kubernetes, we will officially support the last 3 versions as described in [k8s versioning](https://kubernetes.io/releases/version-skew-policy/#supported-versions). Any version before the last 3 we will try to support as long it doesn't bring security issues or any big maintenance burden.
+> [!Note]
+> For Kubernetes, we will officially support the last 3 versions as described in [k8s versioning](https://kubernetes.io/releases/version-skew-policy/#supported-versions). Any version before the last 3 we will try to support as long it doesn't bring security issues or any big maintenance burden.
 
 ## FAQ
+
 For any issues see our [FAQ](../../FAQ.md)…
 
 ## Usage

charts/spire/charts/spiffe-csi-driver/README.md

@@ -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

charts/spire/charts/spiffe-oidc-discovery-provider/README.md

@@ -1,14 +1,13 @@
 # spiffe-oidc-discovery-provider
 
-<!-- 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: 1.7.2](https://img.shields.io/badge/AppVersion-1.7.2-informational?style=flat-square)
 
 A Helm chart to install the SPIFFE OIDC discovery provider.
 
 **Homepage:** <https://github.com/spiffe/helm-charts/tree/main/charts/spire>
 
-> **Note**: Minimum Spire version is `1.5.3`.
+> [!Note]
+> Minimum Spire version is `1.5.3`.
 > The recommended version is `1.6.0` to support arm64 nodes. If running with any
 > prior version to `1.6.0` you have to use a `nodeSelector` to limit to `kubernetes.io/arch: amd64`.
 
@@ -25,6 +24,8 @@ A Helm chart to install the SPIFFE OIDC discovery provider.
 
 * <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
 
 ### Chart parameters

charts/spire/charts/spiffe-oidc-discovery-provider/values.yaml

@@ -9,10 +9,10 @@ global: {}
 ## @param agentSocketName The name of the spire-agent unix socket
 agentSocketName: spire-agent.sock
 
-## @param replicaCount Replica count 
+## @param replicaCount Replica count
 replicaCount: 1
 
-## @param namespaceOverride Namespace override 
+## @param namespaceOverride Namespace override
 namespaceOverride: ""
 
 ## @param annotations [object] Annotations for the deployment
@@ -250,7 +250,7 @@ ingress:
     # nginx.ingress.kubernetes.io/ssl-redirect: "true"
     # nginx.ingress.kubernetes.io/force-ssl-redirect: "true"
 
-  ## @param ingress.host Host name for the ingress. If no '.' in host, trustDomain is automatically appended. The rest of the rules will be autogenerated. For more customizability, use hosts[] instead. 
+  ## @param ingress.host Host name for the ingress. If no '.' in host, trustDomain is automatically appended. The rest of the rules will be autogenerated. For more customizability, use hosts[] instead.
   host: "oidc-discovery"
 
   ## @param ingress.tlsSecret Secret that has the certs. If blank will use default certs. Used with host var.

charts/spire/charts/spire-agent/README.md

@@ -1,14 +1,13 @@
 # spire-agent
 
-<!-- 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: 1.7.2](https://img.shields.io/badge/AppVersion-1.7.2-informational?style=flat-square)
 
 A Helm chart to install the SPIRE agent.
 
 **Homepage:** <https://github.com/spiffe/helm-charts/tree/main/charts/spire>
 
-> **Note**: Minimum Spire version is `1.5.3`.
+> [!Note]
+> Minimum Spire version is `1.5.3`.
 > The recommended version is `1.6.0` to support arm64 nodes. If running with any
 > prior version to `1.6.0` you have to use a `nodeSelector` to limit to `kubernetes.io/arch: amd64`.
 
@@ -25,6 +24,8 @@ A Helm chart to install the SPIRE agent.
 
 * <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
 
 ### Chart parameters