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

303 Commits

Author SHA1 Message Date
David Karlsson
9b1f7de05f docs: unify Hub, DVP, and Registry API references (#26048)
@netlify /reference/api/

[Preview the API
reference](https://deploy-preview-26048--docsdocker.netlify.app/reference/api/)

Adds a shared API reference experience for Hub, DVP, and Registry: a
catalog, operation navigation, linked schemas, request and response
examples, and matching HTML and Markdown output. A validation and
generation pipeline prepares the reference data for Hugo and runs as
part of Docker and Netlify builds.

Migrates the three specifications to OpenAPI 3.2, correcting response
shapes, nullable fields, and authentication and token examples. The Hub
migration also corrects SCIM contracts and CSV exports; DVP gains
complete report response schemas and examples. Registry keeps its
documented Hub-specific subset, with authentication and media
negotiation expressed through OpenAPI security and content fields.

Validation is strict for both checks and generation, with no exception
baseline or bypass flag. The build uses the migrated sources directly,
without migration scripts or records.

Page and specification URLs remain stable, including the DVP alias.
Operation and schema anchors change. Engine and Governance retain their
existing references.

Validated locally with Go tests, strict validation of all three
specifications (zero diagnostics), scoped formatting and lint, and a
full Hugo build checking all 176 HTML/Markdown page pairs, example
parity, reference links, and byte-identical published specifications. A
browser check confirmed raw CSV rendering and the generated request
header. No live API requests were made.
2026-09-17 16:56:32 +02:00
David Karlsson
63ddb2912c Merge pull request #25710 from dvdksn/codex/migrate-rumdl
build: migrate Markdown tooling to rumdl
2026-08-05 09:16:24 +02:00
dependabot[bot]
7486675995 chore(deps): bump @docker/marlin-sdk-web-public from 0.5.0 to 0.6.0 (#25505)
Bumps @docker/marlin-sdk-web-public from 0.5.0 to 0.6.0.


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=@docker/marlin-sdk-web-public&package-manager=npm_and_yarn&previous-version=0.5.0&new-version=0.6.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-07-07 15:05:40 +01:00
dependabot[bot]
4a7f8f18fa chore(deps): bump @docker/marlin-sdk-web-public from 0.4.0 to 0.5.0
Bumps @docker/marlin-sdk-web-public from 0.4.0 to 0.5.0.

---
updated-dependencies:
- dependency-name: "@docker/marlin-sdk-web-public"
  dependency-version: 0.5.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-06-30 01:43:51 +00:00
dependabot[bot]
79995d0b31 chore(deps): bump @docker/marlin-sdk-web-public from 0.3.0 to 0.4.0
Bumps @docker/marlin-sdk-web-public from 0.3.0 to 0.4.0.

---
updated-dependencies:
- dependency-name: "@docker/marlin-sdk-web-public"
  dependency-version: 0.4.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-06-22 19:23:30 +00:00
Harrison Crosse
80a807d3ea deps: bump @docker/marlin-sdk-web-public to 0.3.0 (#25257)
Bumps `@docker/marlin-sdk-web-public` from 0.2.0 to 0.3.0.
2026-06-04 10:10:03 +02:00
David Karlsson
9789556384 layouts: render ```mermaid code blocks as diagrams
Adds a Hugo codeblock render hook that turns ```mermaid fences into
<pre class="mermaid"> containers, plus a lazily-loaded mermaid bundle
that only ships on pages that actually contain a diagram. Mirrors the
existing YouTube embed pattern (Store flag + conditional script tag in
baseof) so the main scripts.js bundle stays unchanged.
2026-05-27 11:08:46 +02:00
David Karlsson
a6c2209c7f analytics: add Marlin SDK and migrate dropdown Heap markers
Introduces @docker/marlin-sdk-web-public for first-party pageview and
click analytics, bundled into scripts.js via Hugo's existing js.Build
pipeline. Config is emitted to window.__marlinConfig from head.html and
gated to prod/staging only.

Renames data-heap-id attributes on the markdown-dropdown buttons to
marlin-action so they are picked up by the SDK's auto-click tracking.

TODO: replace the REPLACE-ME endpoint placeholders in hugo.yaml with
the canonical Marlin ingestion URLs from the data-platform team.

TODO: heap.track() calls in youtube-script.html are left in place —
the public SDK exposes no equivalent track() method, so video
play/pause events cannot be migrated yet.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-05-22 13:40:16 +02:00
David Karlsson
ee71c80562 chore: migrate icons from Material Symbols to Heroicons
Replaces @material-symbols/svg-400 (5.5 MB) with heroicons (488 KB) — an
11x reduction in icon asset size. Heroicons uses a single consistent
distribution format (24px solid SVGs, fill="currentColor") eliminating
the need for the separate utils/svg.html partial, the icon-svg-stroke CSS
utility, and the dual-path resolution logic in icon.html.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-05-18 12:05:54 +02:00
David Karlsson
00aefd5eae chore: pin GitHub Actions to full commit SHA; lock npm exact versions
All mutable action tags replaced with verified commit SHAs to prevent
supply-chain attacks via tag mutation. package.json ^ ranges replaced
with exact versions from package-lock.json.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-24 17:16:06 +01:00
David Karlsson
6dabf0d176 deps: upgrade npm dependencies
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-03-17 09:19:07 +01:00
David Karlsson
d3a595ef6a site: use gordon for ask ai
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-01-13 12:21:28 +01:00
David Karlsson
7418c6c0f3 deps: delete unused @tailwindcss/nesting package
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-11-03 15:27:13 +01:00
David Karlsson
8e6cc3deed deps: upgrade prettier-plugin-tailwindcss to v0.7.1
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-11-03 15:24:10 +01:00
David Karlsson
b41b7ab11b deps: upgrade prettier to v3.6.2
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-11-03 15:24:10 +01:00
David Karlsson
1cb27f2f58 deps: upgrade markdownlint to v0.38.0
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-11-03 15:24:07 +01:00
Arthur
038e6dc682 chore: update Tailwind to v4 (#22666)
- Extract classes to utilities and components.
- Reduce number of colors used.
- Harmonize button colors.
- Restyle admonitions.
- Move **Page options** button to main article.
- Various color tweaks.
2025-05-28 08:37:10 +01:00
David Karlsson
6e38856d9f deps: bump @floatingui/dom
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-18 10:50:53 +01:00
David Karlsson
7980ee8dca deps: bump tailwindcss and plugins
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-18 10:49:42 +01:00
David Karlsson
3cf7531c0e deps: bump postcss
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-18 10:48:56 +01:00
David Karlsson
e748d24301 deps: bump alpinejs to v3.14.3
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-18 10:46:27 +01:00
David Karlsson
cac579e760 deps(dev): update prettier-plugin-tailwindcss to v0.6.8
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-27 12:09:29 +02:00
David Karlsson
0b30dbd231 deps: update tailwindcss to v3.4.13
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-27 12:09:29 +02:00
David Karlsson
a5d0beb21d deps: update postcss to v8.4.47
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-27 12:09:29 +02:00
David Karlsson
31c573c27f deps: update autoprefixer to v10.4.20
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-27 12:09:29 +02:00
David Karlsson
a9179a5086 deps: update @floating-ui/dom to v1.6.11
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-27 12:09:29 +02:00
David Karlsson
d3b966e9f6 deps: update material-symbols icons to v0.23.0
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-27 12:09:29 +02:00
David Karlsson
55e5c95981 deps(dev): update markdownlint@0.35.0, markdownlint-cli2@0.14.0
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-27 12:09:26 +02:00
David Karlsson
4443d3640a hugo: update layout architecture
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-16 14:43:05 +02:00
David Karlsson
b857d14fb3 build(deps): upgrade autoprefixer
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-06-24 10:00:43 +02:00
David Karlsson
5ee936c15c build(deps): upgrade tailwind
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-06-24 09:59:38 +02:00
David Karlsson
39ea097c8b build(deps): upgrade floating-ui
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-06-24 09:58:37 +02:00
David Karlsson
a01215d2bc build(deps): upgrade postcss
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-06-24 09:56:53 +02:00
David Karlsson
825903b941 build(deps): upgrade prettier
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-06-24 09:56:11 +02:00
David Karlsson
7cfa4f2f63 build(deps): upgrade markdownlint to v0.34
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-06-24 09:55:10 +02:00
David Karlsson
aa497de6c9 build(deps): upgrade alpinejs to 3.14.1
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-06-24 09:54:18 +02:00
David Karlsson
97307d4c66 search: pagefind v1.1.0
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-05-23 14:05:59 +02:00
David Karlsson
6ccbfa3f64 hugo: use fuse.js search instead of algolia
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-04-26 14:36:13 +02:00
Ajeet Singh Raina, Docker Captain, ARM Innovator
a846de1787 Add documentation for core Docker concepts and guides (#19691)
* Added the-basic pages
---------

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Co-authored-by: Michael Irwin <mikesir87@gmail.com>
Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>
2024-03-27 14:09:35 -07:00
David Karlsson
36d3f62159 feat: add tooltip partial
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-23 15:03:27 +01:00
David Karlsson
0fec9e909c build(deps): upgrade nodejs prod dependencies
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-01 10:00:04 +01:00
David Karlsson
9d2e4694ca chore: upgrade nodejs dev dependencies
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-01 09:49:15 +01:00
David Karlsson
f6191387b6 chore: remove mermaid.js
We're not using mermaid for diagrams anymore so we can prune the
dependency.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-01 09:46:24 +01:00
David Karlsson
6aced2fc9d build(deps): remove refactor nodejs dependencies
Separate dev dependencies like prettier to prevent them from being
installed to build the site, unnecessarily.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-01 09:44:56 +01:00
David Karlsson
1f42d72ed3 hugo: support for inline svg icons
This commit adds support for icon optimization using inline svgs,
improving site performance.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-25 12:28:38 +01:00
David Karlsson
a0d21ade2f migrate to hugo
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-08-22 09:41:02 +02:00
Misty Stanley-Jones
701f170a21 Move docker-hub docs to docker-hub subdirectory 2016-09-29 10:38:52 -07:00
Misty Stanley-Jones
4d1a62276e Imitial import of https://github.com/docker/hub2-demo 2016-09-29 10:35:53 -07:00
Misty Stanley-Jones
0b95b86011 Move kitematic docs to kitematic subdirectory 2016-09-28 16:46:17 -07:00
French Ben
02c9f96071 Kitematic version to match engine
Signed-off-by: French Ben <frenchben@docker.com>
2016-07-27 13:51:41 -07:00