Skip to content

Commit 4e1d7e3

Browse files
authored
chore: reduce Vale reporting noise (#23142)
Edit Vale config to be more lenient with generated content. Number of errors: - Before: 5473 - After: 2690
1 parent 778515e commit 4e1d7e3

File tree

3 files changed

+41
-17
lines changed

3 files changed

+41
-17
lines changed

.vale.ini

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,25 @@
11
StylesPath = _vale
22
MinAlertLevel = suggestion
3-
3+
IgnoredScopes = text.frontmatter, code, tt, b, strong, i
44
Vocab = Docker
55

6+
# Disable rules for genered content
7+
[content/reference/**/**.md]
8+
Vale.Spelling = NO
9+
Vale.Terms = NO
10+
Docker.Capitalization = NO
11+
12+
[content/manuals/*/release-notes/*.md]
13+
Vale.Spelling = NO
14+
Vale.Terms = NO
15+
Docker.Capitalization = NO
16+
17+
[content/contribute/*.md]
18+
Vale.Spelling = NO
19+
Vale.Terms = NO
20+
Docker.Capitalization = NO
21+
Docker.Exclamation = NO
22+
623
[*.md]
724
BasedOnStyles = Vale, Docker
825
# Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}})
@@ -15,10 +32,3 @@ TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \
1532
# Exclude `{{< myshortcode `This is some <b>HTML</b>, ... >}}`
1633
BlockIgnores = (?sm)^({{[%<] \w+ [^{]*?\s[%>]}})\n$, \
1734
(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}})
18-
19-
# Disable rules for genered content
20-
# Content is checked upstream
21-
[**/{model-cli/docs/reference,content/reference/cli/docker/model}/**.md]
22-
BasedOnStyles = Vale
23-
Vale.Spelling = NO
24-
Vale.Terms = NO

_vale/config/vocabularies/Docker/accept.txt

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
(?i)[A-Z]{2,}'?s
2+
23
Adreno
34
Aleksandrov
45
Amazon
@@ -8,6 +9,7 @@ Artifactory
89
Azure
910
bootup
1011
Btrfs
12+
Bugsnag
1113
BuildKit
1214
BusyBox
1315
CentOS
@@ -16,6 +18,8 @@ cgroup
1618
Chrome
1719
Chrome DevTools
1820
Citrix
21+
cli
22+
CLI
1923
CloudFront
2024
Codefresh
2125
Codespaces
@@ -27,6 +31,7 @@ datacenter
2731
Datadog
2832
Ddosify
2933
Debootstrap
34+
denylist
3035
deprovisioning
3136
deserialization
3237
deserialize
@@ -53,6 +58,7 @@ Dockerize
5358
Dockerizing
5459
Entra
5560
EPERM
61+
ESXi
5662
Ethernet
5763
Fargate
5864
Fedora
@@ -63,7 +69,8 @@ g?libc
6369
GeoNetwork
6470
GGUF
6571
Git
66-
GitHub( Actions)?
72+
GitHub
73+
GitHub Actions
6774
Google
6875
Grafana
6976
Gravatar
@@ -81,6 +88,7 @@ Jamf
8188
JetBrains
8289
JFrog
8390
JUnit
91+
Kata
8492
Kerberos
8593
Kitematic
8694
Kubeadm
@@ -93,6 +101,7 @@ Laravel
93101
libseccomp
94102
Linux
95103
LinuxKit
104+
Loggly
96105
Logstash
97106
lookup
98107
Mac
@@ -110,6 +119,7 @@ namespace
110119
namespacing
111120
netfilter
112121
netlabel
122+
netlink
113123
Netplan
114124
NFSv\d
115125
Nginx
@@ -130,17 +140,20 @@ Postgres
130140
PowerShell
131141
Python
132142
Qualcomm
143+
reimplement
133144
rollback
134145
rootful
135146
runc
136147
Ryuk
137148
S3
138149
scrollable
150+
SELinux
139151
Slack
140152
snapshotters?
141153
Snyk
142154
Solr
143155
SonarQube
156+
Splunk
144157
SQLite
145158
stdin
146159
stdout
@@ -163,13 +176,14 @@ Unix
163176
unmanaged
164177
VMware
165178
vpnkit
166-
vSphere
167179
VSCode
180+
vSphere
168181
Wasm
169182
Windows
170183
windowsfilter
171184
WireMock
172185
Xdebug
186+
youki
173187
Zscaler
174188
Zsh
175189
[Aa]nonymized?

content/contribute/style/voice-tone.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ keywords: style guide, voice, tone, content standards
66

77
## Voice
88

9-
At Docker, we've been the customer. We're developers developing for developers. We speak with experience and knowledge and without arrogance or ego. We want to inform and empower people without being confusing or pushy.
9+
At Docker, we've been the customer. We're developers developing for developers. We speak with experience and knowledge and without arrogance or ego. We want to inform and empower people without being confusing or pushy.
1010

1111
We're not afraid to use a bit of cheeky humor to lighten the conversation (and because we don't take ourselves too seriously) but we're always respectful. We communicate with clarity, empathy, and wit; everything we say should inform and encourage.
1212

@@ -21,14 +21,14 @@ We ensure the information is accurate, succinct, thorough, and easy to understan
2121

2222
All of this means that when we write documentation and UI copy:
2323

24-
1. **We are honest.** We give you all the facts and we don't use misdirection or make ambiguous statements. We don't always have all the answers, but we're doing our best to make life better for developers and we'll tell you how it's going.
25-
2. **We are concise.** We understand the industry of complex and detailed messaging our users live in because we come from the same world. Docker doesn't bulk up our communication with fluffy words or complex metaphors. We're clear and to the point.
26-
3. **We are relaxed.** Our demeanor is casual but not lazy, smart but not arrogant, and focused but not cold. Our voice should be welcoming and warm.
27-
4. **We are inclusive.** Developers are developers no matter how much code they've written. Every person is as much a part of our community as the next. We are accepting of all developers from all industries and experience levels.
24+
1. **We are honest.** We give you all the facts and we don't use misdirection or make ambiguous statements. We don't always have all the answers, but we're doing our best to make life better for developers and we'll tell you how it's going.
25+
2. **We are concise.** We understand the industry of complex and detailed messaging our users live in because we come from the same world. Docker doesn't bulk up our communication with fluffy words or complex metaphors. We're clear and to the point.
26+
3. **We are relaxed.** Our demeanor is casual but not lazy, smart but not arrogant, and focused but not cold. Our voice should be welcoming and warm.
27+
4. **We are inclusive.** Developers are developers no matter how much code they've written. Every person is as much a part of our community as the next. We are accepting of all developers from all industries and experience levels.
2828

2929
## Tone
3030

31-
Docker's tone is usually informal, but we believe it's always more important to be clear over comical. We're relaxed, but we're not inappropriate or unprofessional.
31+
Docker's tone is usually informal, but we believe it's always more important to be clear over comical. We're relaxed, but we're not inappropriate or unprofessional.
3232

3333
### Friendly tone
3434

@@ -46,4 +46,4 @@ For example, **instead of**:
4646

4747
**Use**:
4848

49-
*Features such as Single Sign-on (SSO), Image Access Management, Registry Access Management are available in Docker Business subscription*.”
49+
*Features such as Single Sign-on (SSO), Image Access Management, Registry Access Management are available in Docker Business subscription*.”

0 commit comments

Comments
 (0)