From 9ae282a6846b292e22db9ae9fd7028bc0c3ebf11 Mon Sep 17 00:00:00 2001
From: xeruf <27jf@pm.me>
Date: Thu, 28 Sep 2023 13:09:59 +0200
Subject: [PATCH] Link specific lines in values as examples

---
 README.md | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 540cfb5..8a7a0c9 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,8 @@ Deploys bitnami's PostgreSQL and Redis as subcharts if you want.
 Define ingress settings according to your controller (for both API and Frontend) to access the application.
 You can set all Vikunja API options as yaml under `api.config`: https://vikunja.io/docs/config-options
 
+See [values.yaml](./values.yaml#L140) for examples.
+
 ## Advanced features
 
 ### Replicas
@@ -21,7 +23,7 @@ You can set all Vikunja API options as yaml under `api.config`: https://vikunja.
 Both Frontend and API can be configured to have replicas including autoscaling.
 When replicating the API, make sure to set up the redis cache as well
 by setting `api.config.keyvalue.type` to `redis`,
-configuring the redis subchart (see [values.yaml](./values.yaml))
+configuring the redis subchart (see [values.yaml](./values.yaml#L280))
 and the connection to Vikunja:
 https://vikunja.io/docs/config-options/#redis
 
@@ -31,7 +33,8 @@ Sometimes you have to deploy some cloud-specific resources that are not a part o
 You have to either create an extra chart for that, or manage them with other tools (kustomize, plain manifests etc.).
 That is painful. We have a solution. If you want to create anything that is not present in the chart, *just add it in raw*!
 
-Let's say, you are hosted in [GKE](https://cloud.google.com/kubernetes-engine) and want to use Google-managed TLS certificates.
+Let's say, you are hosted in [GKE](https://cloud.google.com/kubernetes-engine) 
+and want to use Google-managed TLS certificates.
 In order to do that, you have to create a ManagedCertificate resource:
 
 ```yaml
@@ -56,7 +59,9 @@ raw:
     - example.com
 ```
 
-Or, let's say, you have decided to use Google SQL database instead of self-hosted, and placed credentials in Google Secret Manager. You plan to use [ExternalSecrets](https://external-secrets.io/v0.7.2/) to get that credentials. These can be easily integrated as well.
+Or, let's say, you have decided to use Google SQL database instead of self-hosted, and placed credentials in Google Secret Manager.
+You plan to use [ExternalSecrets](https://external-secrets.io/v0.7.2/) to store the credentials. 
+These can be easily integrated as well.
 
 ```yaml
 # Disable embedded database
@@ -121,8 +126,7 @@ Enjoy!
 
 ### Use an existing file volume claim
 
-In the `values.yaml` file, you can configure wether to create the Persistent Volume Claim or use an existing one:
-
+In the `values.yaml` file, you can configure whether to create the Persistent Volume Claim or use an existing one:
 
 ```yaml
     # Specifies whether a PVC should be created
@@ -132,11 +136,13 @@ In the `values.yaml` file, you can configure wether to create the Persistent Vol
     name: "" 
 ```
 
-This is helpful when migrating from a different k8s chart and want to re-use the existing volume or if you need more control over how the volume is created.
+This is helpful when migrating from a different k8s chart and to re-use the existing volume 
+or if you need more control over how the volume is created.
 
 ## Publishing
 
-These steps are automatically performed on a git tag.
+The following steps are automatically performed when a git tag for a new version is pushed to the repository.
+They are only listed here for reference.
 
 1. Pull all dependencies before packaging.