1
0
mirror of https://github.com/docker/docs.git synced 2026-10-23 18:09:02 +03:00
Commit Graph

52 Commits

Author SHA1 Message Date
David Karlsson
77a349bf63 vale: exempt product names ending in '!' from Docker.Exclamation
The Docker.Exclamation rule flags any word followed by an exclamation
point in bare prose, which trips on product names that legitimately end
in '!' such as SDKMAN!. Link text and code are already exempt via
IgnoredScopes, but bare-prose mentions were not.

Add an exceptions list, matched against the word preceding the '!', so
genuine exclamations are still caught while listed product names pass.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-17 12:46:15 +02:00
David Karlsson
44e75340dc vale: drop above/below swaps, ignore shortcodes in links, fill vocab gaps
The above/below substitutions fired on idioms ("above and beyond"),
numeric comparisons ("above the 90th percentile"), and version
references ("macOS Ventura and above"), where "previous"/"following"
makes no sense. Drop them — the canonical "see the example above"
case is mild enough that human review can catch it.

Extend TokenIgnores so shortcodes followed by path segments
(``{{% param "x" %}}/dists/``) and shortcodes nested inside markdown
link text are both treated as opaque. Fixes spurious URL/term hits
across the engine/install pages.

Add vocab entries for legitimate technical terms previously flagged by
Vale.Spelling (bootloader, crypto, Kubuntu/Lubuntu/Xubuntu, lockfile,
multimodal, multithreading, NLP, oldoldstable, parallelizable, pnpm,
superset, tokenization, WebGL). Also wrap the `println` heading in
formatting.md in backticks — it's a Go template function, not prose.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-12 15:03:04 +02:00
David Karlsson
4d0b3c1218 vale: scope log in/out swap to verb forms only
The login/logout swap was firing on noun usages like "sbx login",
"login shell", and "device flow login" — none of which mean "sign in".
Restrict the pattern to verb phrases ("log in", "log on", "sign on",
"log out") so noun forms are left alone.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-12 14:21:44 +02:00
David Karlsson
f6f287b6d4 vale: overhaul ruleset and clean up vocab
The vale ruleset was producing ~1,600 violations, a meaningful fraction
of which were noise from a hard-to-maintain vocabulary file, sprawling
shortcode-ignore regex, and rule patterns with known false positive
modes. This commit cleans up all three.

Vocabulary fixes (accept.txt):
- Fix the case-insensitive catch-all `(?i)[A-Z]{2,}'?s` which was
  matching every plural word and suppressing other rule checks on them
- Fix wrong-cased canonical entries that caused cascading Vale.Terms
  false positives: Duckduckgo→DuckDuckGo, fluentd→Fluentd, [Rr]eadme
  removed (README is correct), VPNKit, AppArmor, OpenSSL, etc.
- Remove `Mac` (Apple brand) — conflicted with `MAC` (address) under
  Vale's case-insensitive vocab matching; both are in the base dictionary
- Resolve duplicate case entries (uncaptured/Uncaptured, etc.) by using
  narrow character-class regex like `[Uu]ncaptured` to opt out of Terms
  enforcement
- Add common tech terms missing from the vocab (Vitest, Deno, Pinecone,
  Wolfi, Streamlit, ESLint, Kustomize, HAProxy, Qdrant, etc.)
- Add common acronyms and abbreviations as canonical uppercase (URL,
  JSON, TCP, UID, SHA, CMD, VM, GPG, KVM)

Rule fixes:
- TokenIgnores/BlockIgnores collapsed from 7 patterns to 2 (one for
  inline shortcodes, one for multi-line block shortcodes)
- Docker.Capitalization regex tightened to skip `docker` preceded or
  followed by `-`/`.` (image names, URLs) and word chars after
  (`dockerd`, `Dockerfile`)
- Docker.RecommendedWords `vs: versus` now excludes "VS Code" and "vs."
  (heading abbreviation)
- Docker.We becomes case-sensitive so `US` (country) isn't flagged as
  the pronoun `us`
- Docker.VersionText requires X.Y minimum to avoid matching port numbers
  like "1025 or higher"
- Docker.Units drops KB→kB swap (KB is conventional in user-facing docs)

Section overrides:
- Brace-expansion glob `[{a,b,c}]` consolidates repeated path lists
- Release notes and previous-versions content fully disabled (each rule
  listed explicitly because Vale's BasedOnStyles= empty in a section
  doesn't actually disable rules, despite the docs)
- Reference content disables Vale.Spelling/Vale.Terms/Docker.Capitalization

Net result: 1,429 → ~1,070 violations, with spot-checks confirming the
remaining violations are real (CLI commands without backticks, first-
person plurals, `allows`→`lets`, etc.) and not artifacts of the rules.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-12 12:40:03 +02:00
luojiyin
9be23c8032 Fix spelling errors across documentation and config files
- seee → see (hub API docs)
- dameon → daemon (release notes)
- plugable → pluggable (release notes)
- adminstrative → administrative (account docs)
- docekr → Docker (opentelemetry guide)
- addFlagLables → addFlagLabels (tensorflowjs guide)
- terrabytes → terabytes (Vale config)
- Dasboard → Dashboard (Vale vocabulary)
- plaform → platform (CLI docs)
- correponds → corresponds (CLI docs)
- digset → digest (buildx docs)

Signed-off-by: luojiyin <luojiyin@hotmail.com>
2026-02-08 13:15:42 +08:00
Arthur
f5a8c24b8f vale: delete unwanted styles (#23273) 2025-08-19 17:17:47 +02:00
Allie Sadler
c7f7588084 chore: minor docs fixes (#23270)
<!--Delete sections as needed -->

## Description

Closes
https://github.com/docker/docs/issues/23255#issuecomment-3193651201
adds
https://docker.slack.com/archives/C0105T139BJ/p1755529270222419?thread_ts=1754585623.672069&cid=C0105T139BJ

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-08-19 10:18:39 +01:00
Arthur
648b55301b fix: fix vale errors (#23218)
<!--Delete sections as needed -->

## Description

Fix Vale and linting errors in AI section.
2025-08-08 10:18:45 +02:00
Arthur
75160e41de fix: clarify requirements (#22971)
Clarify supported platforms.

---------

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-07-02 10:46:48 +02:00
Sebastiaan van Stijn
b6833c2b1d Merge pull request #22731 from thaJeztah/vale_bgp
vale: add "BGP" (Border Gateway Protocol) to acronyms
2025-07-02 07:58:44 +01:00
Allie Sadler
3ffde2a15b contribute improvement (#22920)
<!--Delete sections as needed -->

## Description

Improvements and additions to the UI elements page of our contribute
section

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-06-26 09:49:46 +01:00
Arthur
f18151f86c DMR: plugin install (#22664)
<!--Delete sections as needed -->

## Description

Add DMR Docker Engine plugin install cmd.

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [X] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Co-authored-by: Jacob Howard <jacob@xenoscopic.com>
2025-06-03 11:38:48 +02:00
Paweł Gronowski
48faaa886a engine: 28.2.0
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2025-05-28 18:48:20 +02:00
Sarah Sanders
68fc43e2ef billing: pay by ach transfer (#22473)
<!--Delete sections as needed -->

## Description
- Adds pay by bank account as payment method option
- Adds new section on verifying bank account
- Preview:
https://deploy-preview-22473--docsdocker.netlify.app/billing/payment-method/

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-04-30 12:13:45 -04:00
Allie Sadler
284b9bce58 Merge pull request #22393 from aevesdocker/ENGDOCS-2515c
ENGDOCS-2515c
2025-04-09 15:15:10 +01:00
Allie Sadler
936fad5e49 ENGDOCS-2515 (#22347)
<!--Delete sections as needed -->

## Description

Freshness to DD setup section.

The odd new sentence here and there, but mostly efficiency gains and
tidying

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
2025-04-03 14:39:55 +01:00
Djordje Lukic
9020de21a0 Merge pull request #22330 from rumpl/gordon-mcp-server
Gordon: docs about MCP built-in tools and its MCP server capabilities
2025-03-31 15:25:54 +01:00
Allie Sadler
2de298e0af Merge pull request #22225 from aevesdocker/ENGDOCS-2478
ENGDOCS-2478
2025-03-13 08:32:01 +00:00
Paweł Gronowski
7cf1b1cac4 engine: 28.0.0 release notes (#21932)
<!--Delete sections as needed -->

## Description

engine: 28.0.0 release notes

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
Co-authored-by: aevesdocker <allie.sadler@docker.com>
2025-02-20 10:09:36 +00:00
Djordje Lukic
6d0fbf3834 Add documentation for MCP usage with Gordon (#21955)
<!--Delete sections as needed -->

## Description

* Moved gordon into its own directory
* Add a page that explains how MCP servers work with Gordon

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [x] Technical review
- [x] Editorial review
- [ ] Product review

---------

Signed-off-by: Djordje Lukic <djordje.lukic@docker.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-02-03 17:41:40 +00:00
Allie Sadler
228cc0f586 Engdocs 2329 (#21847)
<!--Delete sections as needed -->

## Description

Admin guide on user and access management

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-01-23 15:51:08 +00:00
Allie Sadler
672a2130bb Engdocs 2335b (#21809)
<!--Delete sections as needed -->

## Description

This PR reorganizes some of the Docker Hub release notes (RN) content,
moving it into a separate, dedicated Platform release notes section.

With the introduction of a distinct Platform section in the docs,
encompassing its own products, certain content from the Docker Hub
release notes no longer applies. Similarly, some updates from the Docker
Desktop release notes are better highlighted in the new Platform RN.

As more features are added to the Admin Console, Docker Home, and
security, billing, subscrption products, this new release notes section
will serve as a central hub for updates and fixes, making it easier for
admins to stay informed.

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-01-15 10:19:16 +00:00
David Karlsson
4a6c5aeb30 vale: add exceptions for PHP-related terms
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-01-09 13:39:50 +01:00
Allie Sadler
bfd46ac620 ENGDOCS-2360 (#21725)
<!--Delete sections as needed -->

## Description

Looks larger than it is: - 

- A follow-up to comments on https://github.com/docker/docs/pull/21639
- Deals with hotjar issue
https://docker.slack.com/archives/C04BMTUC41E/p1734970724382829
- Vale freshness

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
2025-01-07 17:12:17 +00:00
David Karlsson
c18562ce98 Merge pull request #21652 from dvdksn/windowsfilter
engine: add page for the windowsfilter storage driver
2024-12-20 16:40:34 +01:00
David Karlsson
a2e4fd55e1 vale: allow pluralized acronym initialization
E.g., "Large Language Models (LLMs)" permits the use of "LLM"

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-12-20 15:53:12 +01:00
David Karlsson
7ff0050ec2 engine: add page for the windowsfilter storage driver
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-12-17 13:03:23 +01:00
David Karlsson
7ae25ff532 vale: add NUMA, BSD to acronym exceptions
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-12-17 10:59:13 +01:00
Craig Osterhout
44cce4906f hub: add image library section (#21485)
<!--Delete sections as needed -->

## Description

- Added "Container image library" section in Docker Hub manual and
started adding concepts.
  - Added section about search and all the filters
  - Added section about catalogs
  - Moved mirroring topic inside
- Updated Hub landing page
- Moved "Trusted content" into Repositories>Manage (for publishers) and
Library (for consumers).


https://deploy-preview-21485--docsdocker.netlify.app/docker-hub/

https://deploy-preview-21485--docsdocker.netlify.app/docker-hub/image-library/

https://deploy-preview-21485--docsdocker.netlify.app/docker-hub/image-library/search/

https://deploy-preview-21485--docsdocker.netlify.app/docker-hub/image-library/catalogs/

https://deploy-preview-21485--docsdocker.netlify.app/docker-hub/image-library/trusted-content/


https://deploy-preview-21485--docsdocker.netlify.app/docker-hub/repos/manage/trusted-content/

## Related issues or tickets

ENGDOCS-2352

## Reviews

- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: Craig <craig.osterhout@docker.com>
2024-12-16 08:50:11 -08:00
Sarah Sanders
316115fc76 add docker consolidated subscriptions (#21476)
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

- https://docker.atlassian.net/browse/HD-2066

## Reviews

Final sign offs in Notion doc

---------

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Co-authored-by: Oleg Burov <ob1dev@icloud.com>
2024-12-10 08:37:56 -08:00
Sebastiaan van Stijn
25507129a6 vale: add ZFS as acronym
ZFS; https://en.wikipedia.org/wiki/ZFS

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-12-09 14:20:15 +01:00
Allie Sadler
b26161d3f2 ENGDOCS-2324 (#21475)
<!--Delete sections as needed -->

## Description

Light freshness for ECI content and removes references to DD versions
that users can no longer download

**Note** There is a lot of 'allow' violations. Am deliberately choosing
to ignore them this time.

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2024-11-28 15:20:43 +00:00
Craig Osterhout
5d12cf6a70 hub: refresh/restructure repo content (#21435)
<!--Delete sections as needed -->

## Description

Started refreshing and reorganizing the Hub manual.

- Moved & rearranged the content from "Docker Hub > Manage repositories"
to "Docker Hub > Repositories > Manage" with the following sections:
  - repo info: description, overview, categories
  - access: visibility, collaborators, teams/permissions, roles, OATs
  - images: tags, software artifacts, push images, move images
- Moved the repository features (automated builds, webhooks,
vulnerability scanning) under "Repositories > Manage".
- Moved/added Create, Delete, and Personal settings to top-level of
Repositories
- Filled in some content gaps

https://deploy-preview-21435--docsdocker.netlify.app/docker-hub/repos/

## Related issues or tickets

ENGDOCS-2227

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: Craig <craig.osterhout@docker.com>
2024-11-21 10:35:40 -08:00
David Karlsson
c8cadbb9c5 Merge pull request #21410 from dvdksn/bake-monorepo-guide
guides: build compose projects with bake
2024-11-15 17:15:09 +01:00
David Karlsson
e142d58612 vale: add CI to acronym exceptions
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-14 17:11:30 +01:00
David Karlsson
927298c534 vale: do not flag "Admin Console"
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-13 18:25:18 +01:00
Allie Sadler
c13ed7f2e5 ENGDOCS-2305 (#21397)
<!--Delete sections as needed -->

## Description

Settings Management freshness before the arrival of the SM in the Admin
Console. Have grouped the settings as they appear in the AC.

Page is still quite long and so would like to do some testing (potench
before the year is out) on whether splitting the info on all the
settings into its own 'reference' page would be useful or too 'jumpy'
for users.

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
2024-11-13 10:06:15 +00:00
Allie Sadler
cef62c197d ENGDOCS-2306 (#21398)
<!--Delete sections as needed -->

## Description

Freshness on IAM, HDD index page and Air-gapped containers page. 

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2024-11-12 08:05:58 +00:00
David Karlsson
03120e91a4 vale: move IP from vocabulary to Acronyms rule
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-08 17:44:37 +01:00
David Karlsson
8e2705bedf vale: also check for two-letter acronyms
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-08 17:43:41 +01:00
David Karlsson
d3d0b9605d vale: add GPL, AGPL to acronym exceptions
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-08 17:43:41 +01:00
David Karlsson
9f87432f43 vale: move acronyms from vocabulary to Acronyms rule
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-08 17:43:41 +01:00
David Karlsson
1829e8597c vale: add GNU to acronym exceptions
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-08 16:47:05 +01:00
David Karlsson
7b7ef844cc vale: suggest "distribution" over "distro"
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-08 16:47:05 +01:00
David Karlsson
564705bb73 vale: ignore "TIP" TLA (because it's used in "tip" alerts)
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-27 14:37:10 +02:00
David Karlsson
a634846f29 vale: add some common TLAs
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-27 14:36:12 +02:00
David Karlsson
3cbec0b9f5 vale: fix TLA detection for Acronyms rule
The Acronyms rule was not consistently detecting TLAs

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-27 14:29:13 +02:00
David Karlsson
77695db5d1 chore: sort acronyms alphabetically
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-28 16:01:49 +02:00
David Karlsson
ce9428886c vale: add REST to acronyms
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-28 15:59:23 +02:00
David Karlsson
73839ebf3f vale: don't flag alerts as acronyms
> [!TIP] was being flagged as an undefined acronym

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-28 15:55:43 +02:00