From bcb5b187c7193d0c3b30f74439efc83558da1136 Mon Sep 17 00:00:00 2001
From: xeruf <27jf@pm.me>
Date: Fri, 9 Feb 2024 10:41:59 +0100
Subject: [PATCH] Update README.md according to comments

---
 README.md   | 14 ++++++--------
 values.yaml |  6 +++---
 2 files changed, 9 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index b3953ab..f92e7dc 100644
--- a/README.md
+++ b/README.md
@@ -160,8 +160,7 @@ gitea:
 This chart will set a few defaults in the Forgejo configuration based on the service and ingress settings.
 All defaults can be overwritten in `gitea.config`.
 
-INSTALL_LOCK is always set to true because the configuration in this helm chart
-makes any configuration via installer superfluous.
+INSTALL_LOCK is always set to true because the configuration in this helm chart makes any configuration via installer superfluous.
 
 _All default settings are directly in the generated `app.ini`, not in the Values._
 
@@ -621,7 +620,7 @@ Affected options:
 
 Like the admin user, OAuth2 settings can be updated and disabled but not deleted.
 Deleting OAuth2 settings has to be done in the UI.
-[All OAuth2 values](https://docs.gitea.com/administration/command-line#admin) are available.
+[All OAuth2 values](https://forgejo.org/docs/latest/admin/command-line/#admin-auth-add-oauth) are available.
 
 Multiple OAuth2 sources can be configured with additional OAuth list items.
 
@@ -662,7 +661,7 @@ gitea:
 
 ## Configure commit signing
 
-When using the rootless image, the gpg key folder is not persistent by default.
+When using the rootless image, the GPG key folder is not persistent by default.
 If you want commits by Forgejo (e.g. initial commit) to be signed,
 you need to provide a signing key.
 Prior to [PR186](https://gitea.com/gitea/helm-chart/pulls/186),
@@ -677,9 +676,8 @@ signing:
   gpgHome: /data/git/.gnupg
 ```
 
-Regardless of the used container image the `signing` object allows to specify a private gpg key.
-Either using the `signing.privateKey` to define the key inline,
-or refering to an existing secret containing the key data with `signing.existingSecret`.
+Regardless of the used container image the `signing` object allows to specify a private GPG key.
+Either using the `signing.privateKey` to define the key inline, or referring to an existing secret containing the key data with `signing.existingSecret`.
 
 ```yaml
 apiVersion: v1
@@ -977,7 +975,7 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
 | ------------------------ | ----------------------------------------------------------------- | ------------------ |
 | `signing.enabled`        | Enable commit/action signing                                      | `false`            |
 | `signing.gpgHome`        | GPG home directory                                                | `/data/git/.gnupg` |
-| `signing.privateKey`     | Inline private gpg key for signed Forgejo actions                 | `""`               |
+| `signing.privateKey`     | Inline private GPG key for signed Forgejo actions                 | `""`               |
 | `signing.existingSecret` | Use an existing secret to store the value of `signing.privateKey` | `""`               |
 
 ### Gitea
diff --git a/values.yaml b/values.yaml
index 9c29b77..a93a694 100644
--- a/values.yaml
+++ b/values.yaml
@@ -323,7 +323,7 @@ initContainers:
 #
 ## @param signing.enabled Enable commit/action signing
 ## @param signing.gpgHome GPG home directory
-## @param signing.privateKey Inline private gpg key for signed Forgejo actions
+## @param signing.privateKey Inline private GPG key for signed Forgejo actions
 ## @param signing.existingSecret Use an existing secret to store the value of `signing.privateKey`
 signing:
   enabled: false
@@ -563,8 +563,8 @@ postgresql:
 # By default, removed or moved settings that still remain in a user defined values.yaml will cause Helm to fail running the install/update.
 # Set it to false to skip this basic validation check.
 ## @section Advanced
-## @param checkDeprecation Set it to false to skip this basic validation check.
-## @param test.enabled Set it to false to disable test-connection Pod.
+## @param checkDeprecation Whether to run this basic validation check.
+## @param test.enabled Whether to use test-connection Pod.
 ## @param test.image.name Image name for the wget container used in the test-connection Pod.
 ## @param test.image.tag Image tag for the wget container used in the test-connection Pod.
 checkDeprecation: true