Merge pull request #37 from homarr-labs/docs/README

docs: remove emoji
homarr-labs · Jan 5, 2025 · e4c51a5 · e4c51a5
2 parents c8e200e + 72def0c
commit e4c51a5
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 22 deletions.
diff --git a/charts/homarr/README.md b/charts/homarr/README.md
@@ -14,17 +14,17 @@ A Helm chart to deploy homarr for Kubernetes
 
 * <https://github.com/homarr-labs/homarr>
 
-## 📄 Requirements
+## Requirements
 
 Kubernetes: `>=1.22.0-0`
 
-## 🍱 Dependencies
+## Dependencies
 
 | Repository | Name | Version |
 |------------|------|---------|
 | <https://charts.bitnami.com/bitnami> | mysql | 12.2.0 |
 
-## 🚀 Installing the Chart
+## Installing the Chart
 
 To install the chart with the release name `homarr`
 
@@ -42,7 +42,7 @@ helm repo update
 helm install homarr homarr-labs/homarr
 ```
 
-## ➖ Uninstalling the Chart
+## Uninstalling the Chart
 
 To uninstall the `homarr` deployment
 
@@ -52,7 +52,7 @@ helm uninstall homarr
 
 The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
 
-## 🔧 Configuration
+## Configuration
 
 Read through the [values.yaml](https://github.com/homarr-labs/charts/blob/dev/charts/homarr/values.yaml) file. It has several commented out suggested values.
 
@@ -70,9 +70,9 @@ Alternatively, a YAML file that specifies the values for the above parameters ca
 helm install homarr homarr-labs/homarr -f values.yaml
 ```
 
-## 🎨 Custom configuration
+## Custom configuration
 
-### 🔐 Secrets
+### Secrets
 
 To avoid including sensitive information in plain text within your version control, consider using a declarative approach by applying secrets directly with kubectl apply. For example, instead of including repository credentials in your Helm values, you can leverage a kubernetes secrets manager.
 
@@ -88,7 +88,7 @@ Below is an exhaustive list of all secrets:
 
 </center>
 
-### 🗃️ Database
+### Database
 
 You have multiple options for configuring the database:
 
@@ -212,7 +212,7 @@ database:
 ````
 </details>
 
-### 📸 Images
+### Images
 
 You can import your local images into `homarr-images` PVC
 
@@ -230,7 +230,7 @@ imagesCopy:
 ````
 </details>
 
-### 🌐 Ingress
+### Ingress
 
 The ingress section in the values.yaml file allows you to configure how external traffic accesses your application through an Ingress resource. This section defines whether Ingress is enabled, the class to use, and how to set up hosts, paths, and TLS for secure connections.
 
@@ -260,7 +260,7 @@ ingress:
 
 All available values are listed on the [artifacthub](https://artifacthub.io/packages/helm/homarr/homarr?modal=values). If you find any issue please open an issue on [github](https://github.com/homarr-labs/charts/issues/new?assignees=maintainers&labels=bug&projects=&template=bug_report.yaml)
 
-## 🗃 Values
+## Values
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|

diff --git a/charts/homarr/README_CONFIG.md.gotmpl b/charts/homarr/README_CONFIG.md.gotmpl
@@ -3,13 +3,13 @@ Homarr
 {{- end -}}
 
 {{- define "custom.custom.configuration.header" -}}
-## 🎨 Custom configuration
+## Custom configuration
 {{- end -}}
 
 {{- define "custom.custom.configuration" -}}
 {{ template "custom.custom.configuration.header" . }}
 
-### 🔐 Secrets
+### Secrets
 
 To avoid including sensitive information in plain text within your version control, consider using a declarative approach by applying secrets directly with kubectl apply. For example, instead of including repository credentials in your Helm values, you can leverage a kubernetes secrets manager.
 
@@ -25,7 +25,7 @@ Below is an exhaustive list of all secrets:
 
 </center>
 
-### 🗃️ Database
+### Database
 
 You have multiple options for configuring the database:
 
@@ -151,7 +151,7 @@ database:
 ````
 </details>
 
-### 📸 Images
+### Images
 
 You can import your local images into `homarr-images` PVC
 
@@ -170,7 +170,7 @@ imagesCopy:
 </details>
 
 
-### 🌐 Ingress
+### Ingress
 
 The ingress section in the values.yaml file allows you to configure how external traffic accesses your application through an Ingress resource. This section defines whether Ingress is enabled, the class to use, and how to set up hosts, paths, and TLS for secure connections.
 

diff --git a/hack/templates/README.md.gotmpl b/hack/templates/README.md.gotmpl
@@ -22,13 +22,13 @@ oci://ghcr.io/homarr-labs/charts
 {{- end -}}
 
 {{- define "custom.requirements" -}}
-## 📄 Requirements
+## Requirements
 
 {{ template "chart.kubeVersionLine" . }}
 {{- end -}}
 
 {{- define "custom.dependencies" -}}
-## 🍱 Dependencies
+## Dependencies
 
 {{ if gt (len .Dependencies) 0 }}
 | Repository | Name | Version |
@@ -46,7 +46,7 @@ This chart has no dependencies.
 {{- end -}}
 
 {{- define "custom.install" -}}
-## 🚀 Installing the Chart
+## Installing the Chart
 
 To install the chart with the release name `{{ template "chart.name" . }}`
 
@@ -66,7 +66,7 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
 {{- end -}}
 
 {{- define "custom.uninstall" -}}
-## ➖ Uninstalling the Chart
+## Uninstalling the Chart
 
 To uninstall the `{{ template "chart.name" . }}` deployment
 
@@ -78,7 +78,7 @@ The command removes all the Kubernetes components associated with the chart **in
 {{- end -}}
 
 {{- define "custom.configuration.header" -}}
-## 🔧 Configuration
+## Configuration
 {{- end -}}
 
 {{- define "custom.configuration.readValues" -}}
@@ -104,7 +104,7 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -
 {{- end -}}
 
 {{- define "custom.valuesSection" -}}
-## 🗃 Values
+## Values
 
 {{ template "chart.valuesTable" . }}
 {{- end -}}