Vale CMS Need more than a rule playground? Explore

Company

Docker documentation style guide

17 rules across 5 topics, naming 78 terms.

  • 5 errors
  • 11 warnings
  • 1 suggestion
Read at
0f0154f
License
Apache-2.0
Used by
1 of 355 public configs

The guide, by topic

Select a rule to see what it asks for.

Word choice

10 rules · preferred terms, jargon, and words to avoid

Voice and tone

1 rule · person, tense, contractions, and claims

Punctuation

4 rules · commas, dashes, quotes, and spacing

Headings

1 rule · capitalization and punctuation in titles

Numbers and dates

1 rule · dates, times, units, and ordinals

The word list

Every term this guide’s rules name, and what it says to write instead.

Instead ofWrite
account nameusername
adaptoradapter
administrateadminister
afterwardsafterward
allowslets
alphabeticalphabetical
alphanumericalalphanumeric
amazingAvoid it
an URLa URL
anti-aliasingantialiasing
anti-malwareantimalware
anti-spywareantispyware
anti-virusantivirus
appendixesappendices
assemblerassembly
buildxBuildx
busyboxBusyBox
check boxcheckbox
check boxescheckboxes
clickselect
distrodistribution
docker build cloudDocker Build Cloud
docker businessDocker Business
docker ceDocker Engine
docker composeDocker Compose
docker desktopDocker Desktop
docker engineDocker Engine
docker hubDocker Hub
docker scoutDocker Scout
docker teamDocker Team
dockerfileDockerfile
drop downdrop-down
e.g.for example
easilyAvoid it
ergotherefore
facilitatehelp
facilitatedhelped
facilitateshelps
facilitatinghelping
file namefilename
game-changingAvoid it
githubGitHub
github actionsGitHub Actions
i.e.that is
in order toto
javascriptJavaScript
justAvoid it
keypresskeystroke
kubernetesKubernetes
log outsign out
muticesmutexes
mysqlMySQL
nginxNGINX
nvidiaNVIDIA
pleaseAvoid it
powerfulAvoid it
powershellPowerShell
pytorchPyTorch
reallyAvoid it
reporepository

These rules run in Vale, which checks a whole documentation set against a guide in your editor and on every pull request.

All 16 guides