Skip to content

Commit d75698c

Browse files
authored
docs: adding exceptions to Vale rule (#15431)
1 parent 0c06cf3 commit d75698c

File tree

4 files changed

+30
-16
lines changed

4 files changed

+30
-16
lines changed

‎docs/sources/setup/install/helm/reference.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Helm Chart Values
2+
title: Helm chart values
33
menuTitle: Helm chart values
44
description: Reference for Helm Chart values.
55
aliases:
@@ -10,7 +10,7 @@ keywords: []
1010

1111
<!-- Autogenerated. Modify ../production/helm/loki/reference.md.gotmpl -->
1212

13-
# Helm Chart Values
13+
# Helm chart values
1414
<!-- vale Grafana.Quotes = NO -->
1515
<!-- The reference title is required. Use a noun-based title. -->
1616
<!-- vale Grafana.Quotes = YES -->
@@ -22,6 +22,7 @@ This is the generated reference for the Loki Helm Chart values.
2222
> please refer to the `values.yaml` of the respective Github repository
2323
> [grafana/helm-charts](https://github.com/grafana/helm-charts/tree/main/charts/loki-stack).
2424
25+
<!-- vale Grafana.Spelling = NO -->
2526
<!-- Override default values table from helm-docs. See https://github.com/norwoodj/helm-docs/tree/master#advanced-table-rendering -->
2627

2728
{{< responsive-table >}}
@@ -11782,3 +11783,5 @@ null
1178211783
</table>
1178311784
{{< /responsive-table >}}
1178411785

11786+
<!-- vale Grafana.Spelling = YES -->
11787+

‎docs/sources/shared/configuration.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ value is set to the specified default.
4444
You can use environment variable references in the configuration file to set values that need to be configurable during deployment.
4545
To do this, pass `-config.expand-env=true` and use:
4646

47-
```
47+
```bash
4848
${VAR}
4949
```
5050

@@ -56,7 +56,7 @@ References to undefined variables are replaced by empty strings unless you speci
5656

5757
To specify a default value, use:
5858

59-
```
59+
```bash
6060
${VAR:-default_value}
6161
```
6262

@@ -78,6 +78,8 @@ Pass the `-config.expand-env` flag at the command line to enable this way of set
7878

7979
### Supported contents and default values of `loki.yaml`
8080

81+
<!-- vale Grafana.Spelling = NO -->
82+
8183
```yaml
8284
# A comma-separated list of components to run. The default value 'all' runs Loki
8385
# in single binary mode. The value 'read' is an alias to run only read-path
@@ -6448,6 +6450,8 @@ Configuration for `tracing`.
64486450
[enabled: <boolean> | default = true]
64496451
```
64506452

6453+
<!-- vale Grafana.Spelling = YES -->
6454+
64516455
## Runtime Configuration file
64526456

64536457
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.
@@ -6492,23 +6496,23 @@ on a cluster or per-tenant basis.
64926496
- To disable out-of-order writes for all tenants,
64936497
place in the `limits_config` section:
64946498

6495-
```
6499+
```yaml
64966500
limits_config:
64976501
unordered_writes: false
64986502
```
64996503

65006504
- To disable out-of-order writes for specific tenants,
65016505
configure a runtime configuration file:
65026506

6503-
```
6507+
```yaml
65046508
runtime_config:
65056509
file: overrides.yaml
65066510
```
65076511

65086512
In the `overrides.yaml` file, add `unordered_writes` for each tenant
65096513
permitted to have out-of-order writes:
65106514

6511-
```
6515+
```yaml
65126516
overrides:
65136517
"tenantA":
65146518
unordered_writes: false
@@ -6520,7 +6524,7 @@ is configurable with `max_chunk_age`.
65206524
Loki calculates the earliest time that out-of-order entries may have
65216525
and be accepted with
65226526

6523-
```
6527+
```yaml
65246528
time_of_most_recent_line - (max_chunk_age/2)
65256529
```
65266530

‎docs/templates/configuration.template‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ value is set to the specified default.
4444
You can use environment variable references in the configuration file to set values that need to be configurable during deployment.
4545
To do this, pass `-config.expand-env=true` and use:
4646

47-
```
47+
```bash
4848
${VAR}
4949
```
5050

@@ -56,7 +56,7 @@ References to undefined variables are replaced by empty strings unless you speci
5656

5757
To specify a default value, use:
5858

59-
```
59+
```bash
6060
${VAR:-default_value}
6161
```
6262

@@ -78,8 +78,12 @@ Pass the `-config.expand-env` flag at the command line to enable this way of set
7878

7979
### Supported contents and default values of `loki.yaml`
8080

81+
<!-- vale Grafana.Spelling = NO -->
82+
8183
{{ .ConfigFile }}
8284

85+
<!-- vale Grafana.Spelling = YES -->
86+
8387
## Runtime Configuration file
8488

8589
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.
124128
- To disable out-of-order writes for all tenants,
125129
place in the `limits_config` section:
126130

127-
```
131+
```yaml
128132
limits_config:
129133
unordered_writes: false
130134
```
131135

132136
- To disable out-of-order writes for specific tenants,
133137
configure a runtime configuration file:
134138

135-
```
139+
```yaml
136140
runtime_config:
137141
file: overrides.yaml
138142
```
139143

140144
In the `overrides.yaml` file, add `unordered_writes` for each tenant
141145
permitted to have out-of-order writes:
142146

143-
```
147+
```yaml
144148
overrides:
145149
"tenantA":
146150
unordered_writes: false
@@ -152,7 +156,7 @@ is configurable with `max_chunk_age`.
152156
Loki calculates the earliest time that out-of-order entries may have
153157
and be accepted with
154158

155-
```
159+
```yaml
156160
time_of_most_recent_line - (max_chunk_age/2)
157161
```
158162

‎production/helm/loki/reference.md.gotmpl‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Helm Chart Values
2+
title: Helm chart values
33
menuTitle: Helm chart values
44
description: Reference for Helm Chart values.
55
aliases:
@@ -10,7 +10,7 @@ keywords: []
1010

1111
<!-- Autogenerated. Modify ../production/helm/loki/reference.md.gotmpl -->
1212

13-
# Helm Chart Values
13+
# Helm chart values
1414
<!-- vale Grafana.Quotes = NO -->
1515
<!-- The reference title is required. Use a noun-based title. -->
1616
<!-- vale Grafana.Quotes = YES -->
@@ -22,6 +22,7 @@ This is the generated reference for the Loki Helm Chart values.
2222
> please refer to the `values.yaml` of the respective Github repository
2323
> [grafana/helm-charts](https://github.com/grafana/helm-charts/tree/main/charts/loki-stack).
2424

25+
<!-- vale Grafana.Spelling = NO -->
2526
<!-- Override default values table from helm-docs. See https://github.com/norwoodj/helm-docs/tree/master#advanced-table-rendering -->
2627
{{ define "chart.valuesTableHtml" }}
2728
{{ `{{< responsive-table >}}` }}
@@ -47,3 +48,5 @@ This is the generated reference for the Loki Helm Chart values.
4748
{{ end }}
4849

4950
{{ template "chart.valuesTableHtml" . }}
51+
<!-- vale Grafana.Spelling = YES -->
52+

0 commit comments

Comments
 (0)