Company
Docker documentation style guide
17 rules across 5 topics, naming 78 terms.
- 5 errors
- 11 warnings
- 1 suggestion
- Rules from
- docker/docs-toolkit
- 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 avoidAvoid 12 Canonical names 12 Capitalization Generic CTA Industry terms 14 Meta commentary 3 Promotional openers 2 Recommended words 40 URL format 2 Version text 7
Voice and tone
1 rule · person, tense, contractions, and claimsWe 6
Punctuation
4 rules · commas, dashes, quotes, and spacingExclamation List comma Oxford comma Spacing
Headings
1 rule · capitalization and punctuation in titlesHeading punctuation
Numbers and dates
1 rule · dates, times, units, and ordinalsUnits 5
The word list
Every term this guide’s rules name, and what it says to write instead.
| Instead of | Write | Rule |
|---|---|---|
| account name | username | |
| adaptor | adapter | |
| administrate | administer | |
| afterwards | afterward | |
| allows | lets | |
| alphabetic | alphabetical | |
| alphanumerical | alphanumeric | |
| amazing | Avoid it | |
| an URL | a URL | |
| anti-aliasing | antialiasing | |
| anti-malware | antimalware | |
| anti-spyware | antispyware | |
| anti-virus | antivirus | |
| appendixes | appendices | |
| assembler | assembly | |
| buildx | Buildx | |
| busybox | BusyBox | |
| check box | checkbox | |
| check boxes | checkboxes | |
| click | select | |
| distro | distribution | |
| docker build cloud | Docker Build Cloud | |
| docker business | Docker Business | |
| docker ce | Docker Engine | |
| docker compose | Docker Compose | |
| docker desktop | Docker Desktop | |
| docker engine | Docker Engine | |
| docker hub | Docker Hub | |
| docker scout | Docker Scout | |
| docker team | Docker Team | |
| dockerfile | Dockerfile | |
| drop down | drop-down | |
| e.g. | for example | |
| easily | Avoid it | |
| ergo | therefore | |
| facilitate | help | |
| facilitated | helped | |
| facilitates | helps | |
| facilitating | helping | |
| file name | filename | |
| game-changing | Avoid it | |
| github | GitHub | |
| github actions | GitHub Actions | |
| i.e. | that is | |
| in order to | to | |
| javascript | JavaScript | |
| just | Avoid it | |
| keypress | keystroke | |
| kubernetes | Kubernetes | |
| log out | sign out | |
| mutices | mutexes | |
| mysql | MySQL | |
| nginx | NGINX | |
| nvidia | NVIDIA | |
| please | Avoid it | |
| powerful | Avoid it | |
| powershell | PowerShell | |
| pytorch | PyTorch | |
| really | Avoid it | |
| repo | repository |
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