refactor: move helm README to docs/helm.md

ci/helm-chart/README.md → docs/helm.md

-# code-server
+# code-server Helm Chart
 
 ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 3.11.1](https://img.shields.io/badge/AppVersion-3.11.1-informational?style=flat-square)
 
@@ -23,7 +23,7 @@ package manager.
 
 ## Prerequisites
 
-  - Kubernetes 1.6+
+- Kubernetes 1.6+
 
 ## Installing the Chart
 
@@ -59,51 +59,50 @@ and their default values.
 
 ## Values
 
-| Key | Type | Default | Description |
-|-----|------|---------|-------------|
-| affinity | object | `{}` |  |
-| extraArgs | list | `[]` |  |
-| extraConfigmapMounts | list | `[]` |  |
-| extraContainers | string | `""` |  |
-| extraInitContainers | string | `""` |  |
-| extraSecretMounts | list | `[]` |  |
-| extraVars | list | `[]` |  |
-| extraVolumeMounts | list | `[]` |  |
-| fullnameOverride | string | `""` |  |
-| hostnameOverride | string | `""` |  |
-| image.pullPolicy | string | `"Always"` |  |
-| image.repository | string | `"codercom/code-server"` |  |
-| image.tag | string | `"3.11.1"` |  |
-| imagePullSecrets | list | `[]` |  |
-| ingress.enabled | bool | `false` |  |
-| nameOverride | string | `""` |  |
-| nodeSelector | object | `{}` |  |
-| persistence.accessMode | string | `"ReadWriteOnce"` |  |
-| persistence.annotations | object | `{}` |  |
-| persistence.enabled | bool | `true` |  |
-| persistence.size | string | `"1Gi"` |  |
-| podAnnotations | object | `{}` |  |
-| podSecurityContext | object | `{}` |  |
-| replicaCount | int | `1` |  |
-| resources | object | `{}` |  |
-| securityContext.enabled | bool | `true` |  |
-| securityContext.fsGroup | int | `1000` |  |
-| securityContext.runAsUser | int | `1000` |  |
-| service.port | int | `8443` |  |
-| service.type | string | `"ClusterIP"` |  |
-| serviceAccount.create | bool | `true` |  |
-| serviceAccount.name | string | `nil` |  |
-| tolerations | list | `[]` |  |
-| volumePermissions.enabled | bool | `true` |  |
-| volumePermissions.securityContext.runAsUser | int | `0` |  |
-
-Specify each parameter using the `--set key=value[,key=value]` argument to `helm
-install`. For example,
+| Key                                         | Type   | Default                  | Description |
+| ------------------------------------------- | ------ | ------------------------ | ----------- |
+| affinity                                    | object | `{}`                     |             |
+| extraArgs                                   | list   | `[]`                     |             |
+| extraConfigmapMounts                        | list   | `[]`                     |             |
+| extraContainers                             | string | `""`                     |             |
+| extraInitContainers                         | string | `""`                     |             |
+| extraSecretMounts                           | list   | `[]`                     |             |
+| extraVars                                   | list   | `[]`                     |             |
+| extraVolumeMounts                           | list   | `[]`                     |             |
+| fullnameOverride                            | string | `""`                     |             |
+| hostnameOverride                            | string | `""`                     |             |
+| image.pullPolicy                            | string | `"Always"`               |             |
+| image.repository                            | string | `"codercom/code-server"` |             |
+| image.tag                                   | string | `"3.11.1"`               |             |
+| imagePullSecrets                            | list   | `[]`                     |             |
+| ingress.enabled                             | bool   | `false`                  |             |
+| nameOverride                                | string | `""`                     |             |
+| nodeSelector                                | object | `{}`                     |             |
+| persistence.accessMode                      | string | `"ReadWriteOnce"`        |             |
+| persistence.annotations                     | object | `{}`                     |             |
+| persistence.enabled                         | bool   | `true`                   |             |
+| persistence.size                            | string | `"1Gi"`                  |             |
+| podAnnotations                              | object | `{}`                     |             |
+| podSecurityContext                          | object | `{}`                     |             |
+| replicaCount                                | int    | `1`                      |             |
+| resources                                   | object | `{}`                     |             |
+| securityContext.enabled                     | bool   | `true`                   |             |
+| securityContext.fsGroup                     | int    | `1000`                   |             |
+| securityContext.runAsUser                   | int    | `1000`                   |             |
+| service.port                                | int    | `8443`                   |             |
+| service.type                                | string | `"ClusterIP"`            |             |
+| serviceAccount.create                       | bool   | `true`                   |             |
+| serviceAccount.name                         | string | `nil`                    |             |
+| tolerations                                 | list   | `[]`                     |             |
+| volumePermissions.enabled                   | bool   | `true`                   |             |
+| volumePermissions.securityContext.runAsUser | int    | `0`                      |             |
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
 
 ```console
 $ helm upgrade --install code-server \
-    ci/helm-chart \
-    --set persistence.enabled=false
+  ci/helm-chart \
+  --set persistence.enabled=false
 ```
 
 The above command sets the the persistence storage to false.
@@ -120,7 +119,7 @@ $ helm upgrade --install code-server ci/helm-chart -f values.yaml
 # Extra Containers
 
 There are two parameters which allow to add more containers to pod.
-Use `extraContainers` to add regular containers 
+Use `extraContainers` to add regular containers
 and `extraInitContainers` to add init containers. You can read more
 about init containers in [k8s documentation](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/).
 
@@ -128,7 +127,7 @@ Both parameters accept strings and use them as a templates
 
 Example of using `extraInitContainers`:
 
-``` yaml
+```yaml
 extraInitContainers: |
   - name: customization
     image: {{ .Values.image.repository }}:{{ .Values.image.tag }}
@@ -147,16 +146,15 @@ extraInitContainers: |
     volumeMounts:
       - name: data
         mountPath: /home/coder
-
 ```
 
-With this yaml in file `init.yaml`, you can execute 
+With this yaml in file `init.yaml`, you can execute
 
 ```console
 $ helm upgrade --install code-server \
-    ci/helm-chart \
-    --values init.yaml
+  ci/helm-chart \
+  --values init.yaml
 ```
 
 to deploy code-server with python and golang extensions preinstalled
-before main container have started. 
\ No newline at end of file
+before main container have started.

docs/install.md

@@ -224,7 +224,7 @@ alternative](https://hub.docker.com/r/linuxserver/code-server).
 
 ## Helm
 
-You can install code-server via [Helm](https://github.com/cdr/code-server/blob/main/ci/helm-chart/README.md).
+You can install code-server using the [Helm package manager](https://coder.com/docs/code-server/latest/helm).
 
 ## Windows
 

docs/manifest.json

@@ -37,6 +37,11 @@
           "description": "How to run code-server --link",
           "path": "./link.md"
         },
+        {
+          "title": "Helm",
+          "description": "How to install code-server using the Helm package manager",
+          "path": "./helm.md"
+        },
         {
           "title": "iPad",
           "description": "How to access your code-server installation using an iPad.",