From 8905322410091c39c43c7433b23cd132c68a4af3 Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:41:23 +0100 Subject: [PATCH 01/11] desktop: go links (#22765) ## Description ## Related issues or tickets https://docker.atlassian.net/browse/ENGDOCS-1489 ## Reviews - [ ] Technical review - [ ] Editorial review - [ ] Product review --- data/redirects.yml | 87 ++++++++++++++++++++++++++++++++-------------- 1 file changed, 61 insertions(+), 26 deletions(-) diff --git a/data/redirects.yml b/data/redirects.yml index 0e4cac686d1f..aed83e6b2667 100644 --- a/data/redirects.yml +++ b/data/redirects.yml @@ -10,8 +10,6 @@ # in its help output, which can be redirected to elsewhere in the documentation. "/security/for-developers/access-tokens/": - /go/access-tokens/ -"/desktop/mac/apple-silicon/": - - /go/apple-silicon/ "/reference/api/engine/#deprecated-api-versions": - /engine/api/v1.18/ - /engine/api/v1.19/ @@ -31,9 +29,6 @@ - /reference/api/docker_remote_api_v1.21/ - /reference/api/docker_remote_api_v1.22/ - /reference/api/docker_remote_api_v1.23/ -# redirect for old location of dockerd reference -"/reference/cli/dockerd/": - - /engine/reference/commandline/dockerd/ # redirect updated location of the "running containers" page "/engine/containers/run/": - "/engine/reference/run/" @@ -83,13 +78,6 @@ - /go/formatting/ "/?utm_source=docker&utm_medium=inproductad&utm_campaign=20-11nurturecli_docs": - /go/guides/ -"/desktop/get-started/#credentials-management-for-linux-users": - - /go/linux-credentials/ -"/desktop/use-desktop/pause/": - - /go/mac-desktop-pause/ - - /go/win-desktop-pause/ -"/desktop/settings-and-maintenance/settings/#file-sharing": - - /go/mac-file-sharing/ "/engine/security/rootless/": # Instructions on running docker in rootless mode. This redirect is currently # used in the installation script at "get.docker.com" @@ -98,9 +86,7 @@ - /go/storage-driver/ "/docker-hub/vulnerability-scanning/": - /go/tip-scanning/ -"/desktop/features/wsl/": - # Link used by Docker Desktop to refer users on how to activate WSL 2 - - /go/wsl2/ + "/reference/api/hub/latest/": - /docker-hub/api/latest/ "/reference/api/hub/dvp/": @@ -268,13 +254,6 @@ "/desktop/use-desktop/container/#debug": - /go/debug-gui/ -# Docker Desktop - volumes cloud backup -"/desktop/use-desktop/volumes/#export-a-volume": - - /go/volume-export/ - - /go/volume-export-aws/ - - /go/volume-export-azure/ - - /go/volume-export-gcs/ - # Docker Admin Console - Insights "/admin/organization/insights/": - /go/insights/ @@ -297,10 +276,66 @@ "/docker-hub/usage/pulls/": - /go/hub-pull-limits/ -# Desktop DMR -"/model-runner/": - - /go/model-runner/ - + +# Links in Desktop + # Desktop MCP Toolkit "/ai/mcp-catalog-and-toolkit/toolkit/": - /go/mcp-toolkit/ + +# Desktop DMR +"/model-runner/": + - /go/model-runner/ + +# Docker Desktop - volumes cloud backup +"/desktop/use-desktop/volumes/#export-a-volume": + - /go/volume-export/ + - /go/volume-export-aws/ + - /go/volume-export-azure/ + - /go/volume-export-gcs/ + +# Link used by Docker Desktop to refer users on how to activate WSL 2 +"/desktop/features/wsl/": + - /go/wsl2/ + +"/desktop/get-started/#credentials-management-for-linux-users": + - /go/linux-credentials/ +"/desktop/use-desktop/pause/": + - /go/mac-desktop-pause/ + - /go/win-desktop-pause/ +"/desktop/settings-and-maintenance/settings/#file-sharing": + - /go/mac-file-sharing/ + +"/desktop/use-desktop/container/": + - /go/container/ +"/desktop/use-desktop/images/": + - /go/images/ +"/desktop/use-desktop/volumes/": + - /go/volumes/ +"/extensions/": + - /go/extensions/ +"/engine/cli/completion/": + - /go/completion/ +"/desktop/features/vmm/": + - /go/vmm/ +"/security/for-admins/hardened-desktop/enhanced-container-isolation/": + - /go/eci/ +"/desktop/features/synchronized-file-sharing/": + - /go/synchronized-file-sharing/ +"/reference/cli/dockerd/": + - /go/daemon/ +"/ai/gordon/": + - /go/gordon/ +"/desktop/features/wasm/": + - /go/wasm/ +"/compose/bridge/": + - /go/compose-bridge/ +"/desktop/settings-and-maintenance/settings/": + - /go/notifications/ +"/desktop/setup/install/mac-permission-requirements/#installing-symlinks": + - /go/symlinks/ +"/desktop/setup/install/mac-permission-requirements/": + - /go/permissions/ +"/desktop/setup/install/mac-permission-requirements/#binding-privileged-ports": + - /go/port-mapping/ + \ No newline at end of file From 28e68f6af7a9a6c2615f21307b650dcdc88dfae1 Mon Sep 17 00:00:00 2001 From: Arthur Date: Wed, 4 Jun 2025 14:02:48 +0200 Subject: [PATCH 02/11] chore: delete duplicated vale config (#22767) --- _vale/.vale-config/0-Hugo.ini | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 _vale/.vale-config/0-Hugo.ini diff --git a/_vale/.vale-config/0-Hugo.ini b/_vale/.vale-config/0-Hugo.ini deleted file mode 100644 index 4347ca9e902a..000000000000 --- a/_vale/.vale-config/0-Hugo.ini +++ /dev/null @@ -1,10 +0,0 @@ -[*.md] -# Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}}) -TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \ -(\[.+\]\({{< .+ >}}\)), \ -[^\S\r\n]({{[%<] \w+ .+ [%>]}})\s, \ -[^\S\r\n]({{[%<](?:/\*) .* (?:\*/)[%>]}})\s - -# Exclude `{{< myshortcode `This is some HTML, ... >}}` -BlockIgnores = (?sm)^({{[%<] \w+ [^{]*?\s[%>]}})\n$, \ -(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}}) From 6a940f3b2aa50761be46bb2b494de55fa5f530e9 Mon Sep 17 00:00:00 2001 From: Arthur Date: Wed, 4 Jun 2025 15:38:11 +0200 Subject: [PATCH 03/11] ux: update code block styling (#22761) ![export](https://github.com/user-attachments/assets/9a9df60b-22db-42b9-9b5d-3d2c7812bb0e) --- .vscode/docker.code-snippets | 10 +++ assets/css/utilities.css | 10 +-- hugo_stats.json | 46 +++++++------ .../_default/_markup/render-codeblock.html | 65 +++++++++++-------- 4 files changed, 77 insertions(+), 54 deletions(-) diff --git a/.vscode/docker.code-snippets b/.vscode/docker.code-snippets index 18fde97b1548..4342ae2890ee 100644 --- a/.vscode/docker.code-snippets +++ b/.vscode/docker.code-snippets @@ -39,6 +39,16 @@ ], "description": "Insert a Hugo tabs block with two tabs and snippet stops for names and content", }, + "Insert Hugo code block (no title)": { + "prefix": ["codeblock", "block"], + "body": ["```${1:json}", "$2", "```", ""], + "description": "Insert a Hugo code block with an optional title", + }, + "Insert Hugo code block (with title)": { + "prefix": ["codeblock", "codettl", "block"], + "body": ["```${1:json} {title=\"$2\"}", "$3", "```", ""], + "description": "Insert a Hugo code block with an optional title", + }, "Insert a Button": { "prefix": ["button"], "body": ["{{< button url=\"$1\" text=\"$2\" >}}"], diff --git a/assets/css/utilities.css b/assets/css/utilities.css index 99471943da6d..90931e66694e 100644 --- a/assets/css/utilities.css +++ b/assets/css/utilities.css @@ -144,12 +144,8 @@ font-size: 0.875em; border: 1px solid; border-radius: 0.25rem; /* theme("spacing.1") fallback */ - background: var(--color-white-main); - border-color: var(--color-gray-300); - .dark & { - background: var(--color-gray-200); - border-color: var(--color-gray-400); - } + border: none; + background: transparent; &::before, &::after { content: none !important; @@ -185,7 +181,7 @@ } .highlight { - @apply my-4 overflow-x-auto p-3; + @apply my-0 overflow-x-auto p-2; /* LineTableTD */ .lntd { diff --git a/hugo_stats.json b/hugo_stats.json index ce7c37f18377..a0b02ae90322 100644 --- a/hugo_stats.json +++ b/hugo_stats.json @@ -8,6 +8,7 @@ "-mr-8", "-mt-0.5", "-mt-8", + "-top-10", "-top-16", "-v", "-z-10", @@ -116,7 +117,6 @@ "Using-the-GUI", "Using-the-MCP-Toolkit-Recommended", "VS-Code", - "Via-Docker-Desktop-Recommended", "Vue", "WSL-2-backend-Arm-Early-Access", "WSL-2-backend-x86_64", @@ -155,9 +155,7 @@ "bg-blue-500", "bg-gradient-to-br", "bg-gradient-to-r", - "bg-gray-00", "bg-gray-100", - "bg-gray-200", "bg-gray-400", "bg-gray-50", "bg-gray-700", @@ -190,6 +188,7 @@ "border-white", "bottom-0", "build-push-action", + "button", "card", "card-content", "card-description", @@ -198,32 +197,29 @@ "card-img", "card-link", "card-title", + "chip", "chroma", "cls-1", "cls-2", "col-start-2", "containerd-image-store", "cursor-pointer", - "dark:bg-amber-300", + "dark:bg-amber-400", "dark:bg-background-dark", "dark:bg-background-toc", "dark:bg-blue", - "dark:bg-blue-300", "dark:bg-blue-400", "dark:bg-blue-500", "dark:bg-blue-800", "dark:bg-gray-300", - "dark:bg-gray-400", "dark:bg-gray-500", "dark:bg-gray-800", "dark:bg-gray-900", "dark:bg-gray-950", - "dark:bg-green-300", "dark:bg-green-700", "dark:bg-green-dark-400", "dark:bg-navbar-bg-dark", - "dark:bg-red-300", - "dark:bg-violet-300", + "dark:bg-red-400", "dark:bg-violet-400", "dark:block", "dark:border-b-blue-600", @@ -242,10 +238,11 @@ "dark:hover:bg-blue-400", "dark:hover:bg-blue-500", "dark:hover:bg-blue-700", - "dark:hover:bg-gray-500", + "dark:hover:bg-gray-600", "dark:hover:bg-gray-800", "dark:hover:bg-gray-900", "dark:hover:text-blue", + "dark:outline-gray-800", "dark:prose-invert", "dark:ring-3-blue-dark-400", "dark:ring-3-gray-dark-400", @@ -259,7 +256,6 @@ "dark:text-gray-300", "dark:text-gray-400", "dark:text-gray-500", - "dark:text-gray-900", "dark:text-magenta-dark", "dark:text-white", "dark:to-blue-400", @@ -284,6 +280,7 @@ "focus:ring-3-blue-light", "font-bold", "font-medium", + "font-normal", "font-semibold", "footnote-backref", "footnote-ref", @@ -295,6 +292,7 @@ "gap-10", "gap-12", "gap-2", + "gap-2.5", "gap-20", "gap-3", "gap-4", @@ -331,7 +329,6 @@ "hover:border-white/20", "hover:dark:bg-blue-500", "hover:dark:bg-gray-300", - "hover:dark:bg-gray-700", "hover:dark:bg-gray-800", "hover:dark:text-blue-400", "hover:dark:text-blue-700", @@ -375,7 +372,6 @@ "lntable", "lntd", "m-2", - "m-4", "macOS", "max-h-full", "max-w-4xl", @@ -386,8 +382,8 @@ "max-w-none", "max-w-xl", "mb-1", + "mb-1.5", "mb-2", - "mb-3", "mb-4", "mb-6", "mb-8", @@ -406,6 +402,7 @@ "md:text-sm", "md:top-16", "md:w-[300px]", + "md:w-[320px]", "md:z-auto", "min-h-screen", "min-w-0", @@ -416,6 +413,7 @@ "ml-4", "ml-auto", "mt-1", + "mt-1.5", "mt-2", "mt-20", "mt-4", @@ -425,7 +423,10 @@ "my-0", "my-4", "my-6", + "navbar-entry-background-current", + "navbar-entry-margin", "navbar-font", + "navbar-group", "navbar-group-font-title", "no-underline", "no-wrap", @@ -436,7 +437,11 @@ "origin-bottom-right", "origin-top-right", "ot-sdk-show-settings", + "outline", + "outline-1", + "outline-gray-200", "outline-hidden", + "outline-offset-[-1px]", "overflow-clip", "overflow-hidden", "overflow-x-auto", @@ -444,6 +449,7 @@ "overflow-y-auto", "p-1", "p-2", + "p-3", "p-4", "p-6", "p-8", @@ -467,11 +473,11 @@ "pt-10", "pt-2", "pt-4", - "pt-5", "px-1", "px-2", "px-4", "px-6", + "py-0.5", "py-1", "py-2", "py-20", @@ -479,16 +485,16 @@ "py-8", "relative", "right-0", - "right-3", + "right-2", "right-8", "ring-3-2", "ring-3-[1.5px]", "ring-3-blue-light-400", "ring-3-gray-light-200", "rotate-45", + "rounded", "rounded-full", "rounded-sm", - "rounded-sm-b-lg", "scale-50", "scale-75", "scroll-mt-2", @@ -526,11 +532,11 @@ "text-blue-light", "text-divider-light", "text-gray", - "text-gray-100", "text-gray-200", + "text-gray-300", "text-gray-400", + "text-gray-500", "text-gray-600", - "text-gray-800", "text-left", "text-lg", "text-magenta-light", @@ -543,8 +549,8 @@ "to-blue-500", "toc", "top-0", + "top-1", "top-16", - "top-3", "top-6", "top-full", "transition", diff --git a/layouts/_default/_markup/render-codeblock.html b/layouts/_default/_markup/render-codeblock.html index f79fcd46582c..c0a0addb6dc9 100644 --- a/layouts/_default/_markup/render-codeblock.html +++ b/layouts/_default/_markup/render-codeblock.html @@ -1,33 +1,47 @@ -
+
{{ with .Attributes.title }} -
- {{ . }} +
+
+
+ {{ . }} +
+
{{ end }} -
- - +
{{ $lang := .Type | default "text" }} {{ $result := transform.Highlight .Inner $lang .Options }} -
+
+ {{ with .Attributes.collapse }}
-