chore: reduce Vale reporting noise (#23142)

Edit Vale config to be more lenient with generated content. 

Number of errors:
- Before: 5473
- After: 2690
This commit is contained in:
Arthur 2025-07-23 11:10:56 +02:00 committed by GitHub
parent 778515e9a3
commit 4e1d7e3c8d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 41 additions and 17 deletions

View File

@ -1,8 +1,25 @@
StylesPath = _vale
MinAlertLevel = suggestion
IgnoredScopes = text.frontmatter, code, tt, b, strong, i
Vocab = Docker
# Disable rules for genered content
[content/reference/**/**.md]
Vale.Spelling = NO
Vale.Terms = NO
Docker.Capitalization = NO
[content/manuals/*/release-notes/*.md]
Vale.Spelling = NO
Vale.Terms = NO
Docker.Capitalization = NO
[content/contribute/*.md]
Vale.Spelling = NO
Vale.Terms = NO
Docker.Capitalization = NO
Docker.Exclamation = NO
[*.md]
BasedOnStyles = Vale, Docker
# Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}})
@ -15,10 +32,3 @@ TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \
# Exclude `{{< myshortcode `This is some <b>HTML</b>, ... >}}`
BlockIgnores = (?sm)^({{[%<] \w+ [^{]*?\s[%>]}})\n$, \
(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}})
# Disable rules for genered content
# Content is checked upstream
[**/{model-cli/docs/reference,content/reference/cli/docker/model}/**.md]
BasedOnStyles = Vale
Vale.Spelling = NO
Vale.Terms = NO

View File

@ -1,4 +1,5 @@
(?i)[A-Z]{2,}'?s
Adreno
Aleksandrov
Amazon
@ -8,6 +9,7 @@ Artifactory
Azure
bootup
Btrfs
Bugsnag
BuildKit
BusyBox
CentOS
@ -16,6 +18,8 @@ cgroup
Chrome
Chrome DevTools
Citrix
cli
CLI
CloudFront
Codefresh
Codespaces
@ -27,6 +31,7 @@ datacenter
Datadog
Ddosify
Debootstrap
denylist
deprovisioning
deserialization
deserialize
@ -53,6 +58,7 @@ Dockerize
Dockerizing
Entra
EPERM
ESXi
Ethernet
Fargate
Fedora
@ -63,7 +69,8 @@ g?libc
GeoNetwork
GGUF
Git
GitHub( Actions)?
GitHub
GitHub Actions
Google
Grafana
Gravatar
@ -81,6 +88,7 @@ Jamf
JetBrains
JFrog
JUnit
Kata
Kerberos
Kitematic
Kubeadm
@ -93,6 +101,7 @@ Laravel
libseccomp
Linux
LinuxKit
Loggly
Logstash
lookup
Mac
@ -110,6 +119,7 @@ namespace
namespacing
netfilter
netlabel
netlink
Netplan
NFSv\d
Nginx
@ -130,17 +140,20 @@ Postgres
PowerShell
Python
Qualcomm
reimplement
rollback
rootful
runc
Ryuk
S3
scrollable
SELinux
Slack
snapshotters?
Snyk
Solr
SonarQube
Splunk
SQLite
stdin
stdout
@ -163,13 +176,14 @@ Unix
unmanaged
VMware
vpnkit
vSphere
VSCode
vSphere
Wasm
Windows
windowsfilter
WireMock
Xdebug
youki
Zscaler
Zsh
[Aa]nonymized?

View File

@ -6,7 +6,7 @@ keywords: style guide, voice, tone, content standards
## Voice
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.
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.
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.
@ -21,14 +21,14 @@ We ensure the information is accurate, succinct, thorough, and easy to understan
All of this means that when we write documentation and UI copy:
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.
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.
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.
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.
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.
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.
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.
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.
## Tone
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.
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.
### Friendly tone
@ -46,4 +46,4 @@ For example, **instead of**:
**Use**:
“*Features such as Single Sign-on (SSO), Image Access Management, Registry Access Management are available in Docker Business subscription*.”
“*Features such as Single Sign-on (SSO), Image Access Management, Registry Access Management are available in Docker Business subscription*.”