fix docs

fullstack-devops · Jan 16, 2023 · 08410a7 · 08410a7
1 parent 54249d1
commit 08410a7
Show file tree

Hide file tree

Showing 3 changed files with 107 additions and 17 deletions.
diff --git a/charts/excalidraw/Chart.yaml b/charts/excalidraw/Chart.yaml
@@ -4,7 +4,7 @@ description: A Helm chart for Kubernetes
 
 type: application
 
-version: 0.2.7
+version: 0.2.8
 appVersion: 0.0.7
 
 kubeVersion: ">=1.19.0"

diff --git a/charts/excalidraw/README.md b/charts/excalidraw/README.md
@@ -4,13 +4,7 @@
 
 A Helm chart for Kubernetes
 
-**Homepage:** <https://github.com/fullstack-devops/helm-charts/tree/main/charts/excalidraw>
-
-## Maintainers
-
-| Name | Email | Url |
-| ---- | ------ | --- |
-| eksrha | <ekrsha@outlook.de> | <https://github.com/eksrha> |
+**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/fullstack-devops/helm-charts/issues/new/choose)**
 
 ## Source Code
 
@@ -20,7 +14,58 @@ A Helm chart for Kubernetes
 
 ## Requirements
 
-Kubernetes: `>=1.19.0`
+- Kubernetes: `>=1.19.0`
+- Helm 3.2.0+
+- PV provisioner support in the underlying infrastructure
+
+## Dependencies
+
+| Repository | Name | Version |
+|------------|------|---------|
+
+## TL;DR
+
+```console
+helm repo add fs-devops https://fullstack-devops.github.io/helm-charts/
+helm repo update
+helm install excalidraw fs-devops/excalidraw
+```
+
+## Installing the Chart
+
+To install the chart with the release name `excalidraw`
+
+```console
+helm install excalidraw fs-devops/excalidraw
+```
+
+## Uninstalling the Chart
+
+To uninstall the `excalidraw` deployment
+
+```console
+helm uninstall excalidraw
+```
+
+The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
+
+## Configuration
+
+Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+```console
+helm install excalidraw \
+  --set env.TZ="America/New York" \
+    fs-devops/excalidraw
+```
+
+Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
+
+```console
+helm install excalidraw fs-devops/excalidraw -f values.yaml
+```
 
 ## Values
 

diff --git a/charts/github-actions-runner/README.md b/charts/github-actions-runner/README.md
@@ -4,13 +4,7 @@
 
 A Helm chart for Kubernetes
 
-**Homepage:** <https://github.com/fullstack-devops/helm-charts/tree/main/charts/github-actions-runner>
-
-## Maintainers
-
-| Name | Email | Url |
-| ---- | ------ | --- |
-| eksrha | <ekrsha@outlook.de> | <https://github.com/eksrha> |
+**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/fullstack-devops/helm-charts/issues/new/choose)**
 
 ## Source Code
 
@@ -19,7 +13,58 @@ A Helm chart for Kubernetes
 
 ## Requirements
 
-Kubernetes: `>=1.19.0`
+- Kubernetes: `>=1.19.0`
+- Helm 3.2.0+
+- PV provisioner support in the underlying infrastructure
+
+## Dependencies
+
+| Repository | Name | Version |
+|------------|------|---------|
+
+## TL;DR
+
+```console
+helm repo add fs-devops https://fullstack-devops.github.io/helm-charts/
+helm repo update
+helm install github-actions-runner fs-devops/github-actions-runner
+```
+
+## Installing the Chart
+
+To install the chart with the release name `github-actions-runner`
+
+```console
+helm install github-actions-runner fs-devops/github-actions-runner
+```
+
+## Uninstalling the Chart
+
+To uninstall the `github-actions-runner` deployment
+
+```console
+helm uninstall github-actions-runner
+```
+
+The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
+
+## Configuration
+
+Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+```console
+helm install github-actions-runner \
+  --set env.TZ="America/New York" \
+    fs-devops/github-actions-runner
+```
+
+Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
+
+```console
+helm install github-actions-runner fs-devops/github-actions-runner -f values.yaml
+```
 
 ## Values