docs: adding exceptions to Vale rule (#15431)

(cherry picked from commit d75698c)
grafana · Dec 17, 2024 · fe99d13 · fe99d13
1 parent bfcda43
commit fe99d13
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 16 deletions.
diff --git a/docs/sources/setup/install/helm/reference.md b/docs/sources/setup/install/helm/reference.md
@@ -1,5 +1,5 @@
 ---
-title: Helm Chart Values
+title: Helm chart values
 menuTitle: Helm chart values
 description: Reference for Helm Chart values.
 aliases:
@@ -10,7 +10,7 @@ keywords: []
 
 <!-- Autogenerated. Modify ../production/helm/loki/reference.md.gotmpl -->
 
-# Helm Chart Values
+# Helm chart values
 <!-- vale Grafana.Quotes = NO -->
 <!-- The reference title is required. Use a noun-based title. -->
 <!-- vale Grafana.Quotes = YES -->
@@ -22,6 +22,7 @@ This is the generated reference for the Loki Helm Chart values.
 > please refer to the `values.yaml` of the respective Github repository
 > [grafana/helm-charts](https://github.com/grafana/helm-charts/tree/main/charts/loki-stack).
 
+<!-- vale Grafana.Spelling = NO -->
 <!-- Override default values table from helm-docs. See https://github.com/norwoodj/helm-docs/tree/master#advanced-table-rendering -->
 
 {{< responsive-table >}}
@@ -10772,3 +10773,5 @@ null
 </table>
 {{< /responsive-table >}}
 
+<!-- vale Grafana.Spelling = YES -->
+
diff --git a/docs/sources/shared/configuration.md b/docs/sources/shared/configuration.md
@@ -44,7 +44,7 @@ value is set to the specified default.
 You can use environment variable references in the configuration file to set values that need to be configurable during deployment.
 To do this, pass `-config.expand-env=true` and use:
 
-```
+```bash
 ${VAR}
 ```
 
@@ -56,7 +56,7 @@ References to undefined variables are replaced by empty strings unless you speci
 
 To specify a default value, use:
 
-```
+```bash
 ${VAR:-default_value}
 ```
 
@@ -78,6 +78,8 @@ Pass the `-config.expand-env` flag at the command line to enable this way of set
 
 ### Supported contents and default values of `loki.yaml`
 
+<!-- vale Grafana.Spelling = NO -->
+
 ```yaml
 # A comma-separated list of components to run. The default value 'all' runs Loki
 # in single binary mode. The value 'read' is an alias to run only read-path
@@ -5784,6 +5786,8 @@ Configuration for `tracing`.
 [enabled: <boolean> | default = true]
 ```
 
+<!-- vale Grafana.Spelling = YES -->
+
 ## Runtime Configuration file
 
 Loki has a concept of "runtime config" file, which is simply a file that is reloaded while Loki is running. It is used by some Loki components to allow operator to change some aspects of Loki configuration without restarting it. File is specified by using `-runtime-config.file=<filename>` flag and reload period (which defaults to 10 seconds) can be changed by `-runtime-config.reload-period=<duration>` flag. Previously this mechanism was only used by limits overrides, and flags were called `-limits.per-user-override-config=<filename>` and `-limits.per-user-override-period=10s` respectively. These are still used, if `-runtime-config.file=<filename>` is not specified.
@@ -5828,23 +5832,23 @@ on a cluster or per-tenant basis.
 - To disable out-of-order writes for all tenants,
 place in the `limits_config` section:
 
-    ```
+    ```yaml
     limits_config:
         unordered_writes: false
     ```
 
 - To disable out-of-order writes for specific tenants,
 configure a runtime configuration file:
 
-    ```
+    ```yaml
     runtime_config:
       file: overrides.yaml
     ```
 
     In the `overrides.yaml` file, add `unordered_writes` for each tenant
     permitted to have out-of-order writes:
 
-    ```
+    ```yaml
     overrides:
       "tenantA":
         unordered_writes: false
@@ -5856,7 +5860,7 @@ is configurable with `max_chunk_age`.
 Loki calculates the earliest time that out-of-order entries may have
 and be accepted with
 
-```
+```yaml
 time_of_most_recent_line - (max_chunk_age/2)
 ```
 

diff --git a/docs/templates/configuration.template b/docs/templates/configuration.template
@@ -44,7 +44,7 @@ value is set to the specified default.
 You can use environment variable references in the configuration file to set values that need to be configurable during deployment.
 To do this, pass `-config.expand-env=true` and use:
 
-```
+```bash
 ${VAR}
 ```
 
@@ -56,7 +56,7 @@ References to undefined variables are replaced by empty strings unless you speci
 
 To specify a default value, use:
 
-```
+```bash
 ${VAR:-default_value}
 ```
 
@@ -78,8 +78,12 @@ Pass the `-config.expand-env` flag at the command line to enable this way of set
 
 ### Supported contents and default values of `loki.yaml`
 
+<!-- vale Grafana.Spelling = NO -->
+
 {{ .ConfigFile }}
 
+<!-- vale Grafana.Spelling = YES -->
+
 ## Runtime Configuration file
 
 Loki has a concept of "runtime config" file, which is simply a file that is reloaded while Loki is running. It is used by some Loki components to allow operator to change some aspects of Loki configuration without restarting it. File is specified by using `-runtime-config.file=<filename>` flag and reload period (which defaults to 10 seconds) can be changed by `-runtime-config.reload-period=<duration>` flag. Previously this mechanism was only used by limits overrides, and flags were called `-limits.per-user-override-config=<filename>` and `-limits.per-user-override-period=10s` respectively. These are still used, if `-runtime-config.file=<filename>` is not specified.
@@ -124,23 +128,23 @@ on a cluster or per-tenant basis.
 - To disable out-of-order writes for all tenants,
 place in the `limits_config` section:
 
-    ```
+    ```yaml
     limits_config:
         unordered_writes: false
     ```
 
 - To disable out-of-order writes for specific tenants,
 configure a runtime configuration file:
 
-    ```
+    ```yaml
     runtime_config:
       file: overrides.yaml
     ```
 
     In the `overrides.yaml` file, add `unordered_writes` for each tenant
     permitted to have out-of-order writes:
 
-    ```
+    ```yaml
     overrides:
       "tenantA":
         unordered_writes: false
@@ -152,7 +156,7 @@ is configurable with `max_chunk_age`.
 Loki calculates the earliest time that out-of-order entries may have
 and be accepted with
 
-```
+```yaml
 time_of_most_recent_line - (max_chunk_age/2)
 ```
 

diff --git a/production/helm/loki/reference.md.gotmpl b/production/helm/loki/reference.md.gotmpl
@@ -1,5 +1,5 @@
 ---
-title: Helm Chart Values
+title: Helm chart values
 menuTitle: Helm chart values
 description: Reference for Helm Chart values.
 aliases:
@@ -10,7 +10,7 @@ keywords: []
 
 <!-- Autogenerated. Modify ../production/helm/loki/reference.md.gotmpl -->
 
-# Helm Chart Values
+# Helm chart values
 <!-- vale Grafana.Quotes = NO -->
 <!-- The reference title is required. Use a noun-based title. -->
 <!-- vale Grafana.Quotes = YES -->
@@ -22,6 +22,7 @@ This is the generated reference for the Loki Helm Chart values.
 > please refer to the `values.yaml` of the respective Github repository
 > [grafana/helm-charts](https://github.com/grafana/helm-charts/tree/main/charts/loki-stack).
 
+<!-- vale Grafana.Spelling = NO -->
 <!-- Override default values table from helm-docs. See https://github.com/norwoodj/helm-docs/tree/master#advanced-table-rendering -->
 {{ define "chart.valuesTableHtml" }}
 {{ `{{< responsive-table >}}` }}
@@ -47,3 +48,5 @@ This is the generated reference for the Loki Helm Chart values.
 {{ end }}
 
 {{ template "chart.valuesTableHtml" . }}
+<!-- vale Grafana.Spelling = YES -->
+