Skip to content

chore: reduce Vale reporting noise #23142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ArthurFlag merged 1 commit into from
Jul 23, 2025
Merged

chore: reduce Vale reporting noise #23142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]({{< ... >}})
Expand All @@ -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
18 changes: 16 additions & 2 deletions _vale/config/vocabularies/Docker/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
(?i)[A-Z]{2,}'?s

Adreno
Aleksandrov
Amazon
Expand All @@ -8,6 +9,7 @@ Artifactory
Azure
bootup
Btrfs
Bugsnag
BuildKit
BusyBox
CentOS
Expand All @@ -16,6 +18,8 @@ cgroup
Chrome
Chrome DevTools
Citrix
cli
CLI
CloudFront
Codefresh
Codespaces
Expand All @@ -27,6 +31,7 @@ datacenter
Datadog
Ddosify
Debootstrap
denylist
deprovisioning
deserialization
deserialize
Expand All @@ -53,6 +58,7 @@ Dockerize
Dockerizing
Entra
EPERM
ESXi
Ethernet
Fargate
Fedora
Expand All @@ -63,7 +69,8 @@ g?libc
GeoNetwork
GGUF
Git
GitHub( Actions)?
GitHub
GitHub Actions
Google
Grafana
Gravatar
Expand All @@ -81,6 +88,7 @@ Jamf
JetBrains
JFrog
JUnit
Kata
Kerberos
Kitematic
Kubeadm
Expand All @@ -93,6 +101,7 @@ Laravel
libseccomp
Linux
LinuxKit
Loggly
Logstash
lookup
Mac
Expand All @@ -110,6 +119,7 @@ namespace
namespacing
netfilter
netlabel
netlink
Netplan
NFSv\d
Nginx
Expand All @@ -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
Expand All @@ -163,13 +176,14 @@ Unix
unmanaged
VMware
vpnkit
vSphere
VSCode
vSphere
Wasm
Windows
windowsfilter
WireMock
Xdebug
youki
Zscaler
Zsh
[Aa]nonymized?
Expand Down
14 changes: 7 additions & 7 deletions content/contribute/style/voice-tone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## 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.

Check warning on line 9 in content/contribute/style/voice-tone.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.We] Avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'We'.", "location": {"path": "content/contribute/style/voice-tone.md", "range": {"start": {"line": 9, "column": 150}}}, "severity": "WARNING"}

Check warning on line 9 in content/contribute/style/voice-tone.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.We] Avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'We'.", "location": {"path": "content/contribute/style/voice-tone.md", "range": {"start": {"line": 9, "column": 81}}}, "severity": "WARNING"}

Check warning on line 9 in content/contribute/style/voice-tone.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.We] Avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'We'.", "location": {"path": "content/contribute/style/voice-tone.md", "range": {"start": {"line": 9, "column": 37}}}, "severity": "WARNING"}

Check warning on line 9 in content/contribute/style/voice-tone.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.We] Avoid using first-person plural like 'we'.

Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'we'.", "location": {"path": "content/contribute/style/voice-tone.md", "range": {"start": {"line": 9, "column": 12}}}, "severity": "WARNING"}

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.

Expand All @@ -21,14 +21,14 @@

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.

Check warning on line 24 in content/contribute/style/voice-tone.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.We] Avoid using first-person plural like 'our'.

Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'our'.", "location": {"path": "content/contribute/style/voice-tone.md", "range": {"start": {"line": 24, "column": 163}}}, "severity": "WARNING"}

Check warning on line 24 in content/contribute/style/voice-tone.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.We] Avoid using first-person plural like 'we'.

Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'we'.", "location": {"path": "content/contribute/style/voice-tone.md", "range": {"start": {"line": 24, "column": 151}}}, "severity": "WARNING"}

Check warning on line 24 in content/contribute/style/voice-tone.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.We] Avoid using first-person plural like 'we'.

Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'we'.", "location": {"path": "content/contribute/style/voice-tone.md", "range": {"start": {"line": 24, "column": 53}}}, "severity": "WARNING"}

Check warning on line 24 in content/contribute/style/voice-tone.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.We] Avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'We'.", "location": {"path": "content/contribute/style/voice-tone.md", "range": {"start": {"line": 24, "column": 23}}}, "severity": "WARNING"}

Check warning on line 24 in content/contribute/style/voice-tone.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.We] Avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'We'.", "location": {"path": "content/contribute/style/voice-tone.md", "range": {"start": {"line": 24, "column": 6}}}, "severity": "WARNING"}
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.

Check warning on line 25 in content/contribute/style/voice-tone.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.We] Avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'We'.", "location": {"path": "content/contribute/style/voice-tone.md", "range": {"start": {"line": 25, "column": 6}}}, "severity": "WARNING"}
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

Expand All @@ -46,4 +46,4 @@

**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*.”
Loading