From ccb50a846704c991d0a1183031fea03ffb6f4dea Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Fri, 22 Mar 2024 09:37:30 +0100 Subject: [PATCH 1/4] hugo: add tags Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- assets/css/toc.css | 8 +-- content/build/architecture.md | 2 +- content/build/building/secrets.md | 1 + content/build/ci/github-actions/secrets.md | 1 + content/build/dockerfile/release-notes.md | 1 + content/build/release-notes.md | 1 + .../environment-variables/best-practices.md | 1 + content/compose/faq.md | 2 +- content/compose/install/_index.md | 2 +- content/compose/release-notes.md | 1 + content/compose/samples-for-compose.md | 2 +- content/compose/use-secrets.md | 1 + content/config/daemon/troubleshoot.md | 1 + content/contribute/components/call-outs.md | 4 +- content/desktop/_index.md | 31 ++++---- .../design/mui-best-practices.md | 2 +- content/desktop/extensions-sdk/quickstart.md | 2 +- content/desktop/install/archlinux.md | 2 +- content/desktop/release-notes.md | 1 + content/desktop/troubleshoot/known-issues.md | 3 +- content/desktop/troubleshoot/overview.md | 3 +- content/desktop/troubleshoot/topics.md | 1 + content/desktop/troubleshoot/workarounds.md | 3 +- content/desktop/wsl/best-practices.md | 3 +- content/develop/dev-best-practices.md | 1 + .../dockerfile_best-practices.md | 1 + content/develop/develop-images/guidelines.md | 1 + content/develop/security-best-practices.md | 1 + content/docker-hub/builds/troubleshoot.md | 3 +- content/docker-hub/quickstart.md | 2 +- content/docker-hub/release-notes.md | 1 + content/engine/install/linux-postinstall.md | 2 +- content/engine/install/troubleshoot.md | 3 +- content/engine/swarm/secrets.md | 1 + content/faq/_index.md | 2 +- content/release-notes.md | 34 --------- content/scout/release-notes/platform.md | 1 + .../storage/troubleshooting_volume_errors.md | 3 +- content/tags/_index.md | 5 ++ content/tags/best-practices/_index.md | 8 +++ content/tags/release-notes/_index.md | 10 +++ content/tags/secrets/_index.md | 11 +++ content/tags/troubleshooting/_index.md | 8 +++ data/toc.yaml | 2 - hugo.yaml | 6 +- hugo_stats.json | 13 ++++ layouts/_default/list.html | 3 + layouts/_default/single.html | 4 ++ layouts/index.html | 10 +++ layouts/partials/aside.html | 4 +- layouts/partials/category-links.html | 0 layouts/partials/pagemeta.html | 41 +++++++++++ layouts/partials/pagination.html | 70 +++++++++++++++++++ layouts/partials/tags.html | 13 ++++ layouts/partials/toc-default.html | 8 --- layouts/partials/top-nav.html | 2 +- layouts/tag/baseof.html | 19 +++++ layouts/tag/taxonomy.html | 19 +++++ layouts/tag/term.html | 44 ++++++++++++ 59 files changed, 342 insertions(+), 93 deletions(-) delete mode 100644 content/release-notes.md create mode 100644 content/tags/_index.md create mode 100644 content/tags/best-practices/_index.md create mode 100644 content/tags/release-notes/_index.md create mode 100644 content/tags/secrets/_index.md create mode 100644 content/tags/troubleshooting/_index.md create mode 100644 layouts/partials/category-links.html create mode 100644 layouts/partials/pagemeta.html create mode 100644 layouts/partials/pagination.html create mode 100644 layouts/partials/tags.html delete mode 100644 layouts/partials/toc-default.html create mode 100644 layouts/tag/baseof.html create mode 100644 layouts/tag/taxonomy.html create mode 100644 layouts/tag/term.html diff --git a/assets/css/toc.css b/assets/css/toc.css index 151bf77b12..91ff92d7cd 100644 --- a/assets/css/toc.css +++ b/assets/css/toc.css @@ -1,12 +1,6 @@ @layer components { #TableOfContents { - nav { - @apply border-l-2 border-divider-light; - } - ul ul { - @apply pl-2; - } - a { + .toc a { @apply block max-w-full truncate py-1 pl-2 hover:font-medium hover:no-underline; &[aria-current="true"], &:hover { diff --git a/content/build/architecture.md b/content/build/architecture.md index fb11f527f9..a0c81efbea 100644 --- a/content/build/architecture.md +++ b/content/build/architecture.md @@ -90,4 +90,4 @@ For more information about BuildKit, see [BuildKit](buildkit/index.md). The following diagram shows an example build sequence involving Buildx and BuildKit. -![Buildx and BuildKit sequence diagram](./images/build-execution.png) \ No newline at end of file +![Buildx and BuildKit sequence diagram](./images/build-execution.png) diff --git a/content/build/building/secrets.md b/content/build/building/secrets.md index 3813352ab4..31a138f409 100644 --- a/content/build/building/secrets.md +++ b/content/build/building/secrets.md @@ -2,6 +2,7 @@ title: Build secrets description: Manage credentials and other secrets securely keywords: build, secrets, credentials, passwords, tokens, ssh, git, auth, http +tags: [Secrets] --- A build secret is any piece of sensitive information, such as a password or API diff --git a/content/build/ci/github-actions/secrets.md b/content/build/ci/github-actions/secrets.md index e3cd60c049..4a50830903 100644 --- a/content/build/ci/github-actions/secrets.md +++ b/content/build/ci/github-actions/secrets.md @@ -2,6 +2,7 @@ title: Using secrets with GitHub Actions description: Example using secret mounts with GitHub Actions keywords: ci, github actions, gha, buildkit, buildx, secret +tags: [Secrets] --- A build secret is sensitive information, such as a password or API token, consumed as part of the build process. diff --git a/content/build/dockerfile/release-notes.md b/content/build/dockerfile/release-notes.md index 5832652b4e..a89a2e6b09 100644 --- a/content/build/dockerfile/release-notes.md +++ b/content/build/dockerfile/release-notes.md @@ -2,6 +2,7 @@ title: Dockerfile release notes description: Release notes for Dockerfile frontend keywords: build, dockerfile, frontend, release notes +tags: [Release notes] toc_max: 2 --- diff --git a/content/build/release-notes.md b/content/build/release-notes.md index fae34715c7..a9ec1157db 100644 --- a/content/build/release-notes.md +++ b/content/build/release-notes.md @@ -2,6 +2,7 @@ title: Build release notes description: Release notes for Buildx keywords: build, buildx, buildkit, release notes +tags: [Release notes] toc_max: 2 --- diff --git a/content/compose/environment-variables/best-practices.md b/content/compose/environment-variables/best-practices.md index aca402c1ea..575240e1b1 100644 --- a/content/compose/environment-variables/best-practices.md +++ b/content/compose/environment-variables/best-practices.md @@ -3,6 +3,7 @@ title: Best practices for working with environment variables in Docker Compose description: Explainer on the best ways to set, use, and manage environment variables in Compose keywords: compose, orchestration, environment, env file, environment variables +tags: [Best practices] --- #### Handle sensitive information securely diff --git a/content/compose/faq.md b/content/compose/faq.md index ac410fc8dd..5b70024421 100644 --- a/content/compose/faq.md +++ b/content/compose/faq.md @@ -105,4 +105,4 @@ supports hot code reloading or live-reload. There may be cases where you want to use both. You can have the image include the code using a `COPY`, and use a `volume` in your Compose file to include the code from the host during development. The volume overrides -the directory contents of the image. \ No newline at end of file +the directory contents of the image. diff --git a/content/compose/install/_index.md b/content/compose/install/_index.md index 452cf5115d..8afef908f7 100644 --- a/content/compose/install/_index.md +++ b/content/compose/install/_index.md @@ -48,4 +48,4 @@ You can [install the Compose standalone](standalone.md) on Linux or on Windows S > **Warning** > >This install scenario is not recommended and is only supported for backward compatibility purposes. -{ .warning } \ No newline at end of file +{ .warning } diff --git a/content/compose/release-notes.md b/content/compose/release-notes.md index 4cede5d1f7..e8b9f04269 100644 --- a/content/compose/release-notes.md +++ b/content/compose/release-notes.md @@ -2,6 +2,7 @@ title: Docker Compose release notes description: Release notes for Docker Compose keywords: release notes, compose +tags: [Release notes] toc_max: 2 aliases: - /release-notes/docker-compose/ diff --git a/content/compose/samples-for-compose.md b/content/compose/samples-for-compose.md index 5a16218307..5af465fa14 100644 --- a/content/compose/samples-for-compose.md +++ b/content/compose/samples-for-compose.md @@ -39,4 +39,4 @@ These samples focus specifically on Docker Compose: ## Awesome Compose samples -The Awesome Compose samples provide a starting point on how to integrate different frameworks and technologies using Docker Compose. All samples are available in the [Awesome-compose GitHub repo](https://github.com/docker/awesome-compose) and are ready to run with `docker compose up`. \ No newline at end of file +The Awesome Compose samples provide a starting point on how to integrate different frameworks and technologies using Docker Compose. All samples are available in the [Awesome-compose GitHub repo](https://github.com/docker/awesome-compose) and are ready to run with `docker compose up`. diff --git a/content/compose/use-secrets.md b/content/compose/use-secrets.md index 36b9eea715..00ccd16e4f 100644 --- a/content/compose/use-secrets.md +++ b/content/compose/use-secrets.md @@ -2,6 +2,7 @@ title: How to use secrets in Docker Compose description: How to use secrets in Compose and their benefits keywords: secrets, compose, security, environment variables +tags: [Secrets] --- A secret is any piece of data, such as a password, certificate, or API key, that shouldn’t be transmitted over a network or stored unencrypted in a Dockerfile or in your application’s source code. diff --git a/content/config/daemon/troubleshoot.md b/content/config/daemon/troubleshoot.md index 105aedcf9d..3669f9e8b9 100644 --- a/content/config/daemon/troubleshoot.md +++ b/content/config/daemon/troubleshoot.md @@ -2,6 +2,7 @@ title: Troubleshooting the Docker daemon description: Learn how to troubleshoot errors and misconfigurations in the Docker daemon keywords: docker, daemon, configuration, troubleshooting, error, fail to start +tags: [ Troubleshooting ] --- This page describes how to troubleshoot and debug the daemon if you run into diff --git a/content/contribute/components/call-outs.md b/content/contribute/components/call-outs.md index 34178e351e..c0f991606f 100644 --- a/content/contribute/components/call-outs.md +++ b/content/contribute/components/call-outs.md @@ -16,7 +16,7 @@ We support these broad categories of callouts: ## Examples -{{< introduced buildx 0.10.4 "../../release-notes.md#0104" >}} +{{< introduced buildx 0.10.4 >}} > **Note** > @@ -114,4 +114,4 @@ For both of the following callouts, consult [the Docker release lifecycle](/rele > Docker Scout is an [early access](/release-lifecycle/#early-access-ea) > product. { .restricted } -``` \ No newline at end of file +``` diff --git a/content/desktop/_index.md b/content/desktop/_index.md index 53ddf8f624..1e072ff1e6 100644 --- a/content/desktop/_index.md +++ b/content/desktop/_index.md @@ -6,37 +6,33 @@ keywords: how to use docker desktop, what is docker desktop used for, what does title: Overview of Docker Desktop grid: - title: Install Docker Desktop - description: 'Install Docker Desktop on - + description: | + Install Docker Desktop on [Mac](/desktop/install/mac-install/), - [Windows](/desktop/install/windows-install/), or - [Linux](/desktop/install/linux-install/). - - ' icon: download - title: Explore Docker Desktop description: Navigate Docker Desktop and learn about its key features. icon: feature_search - link: /desktop/use-desktop + link: /desktop/use-desktop/ - title: View the release notes description: Find out about new features, improvements, and bug fixes. icon: note_add - link: /desktop/release-notes + link: /desktop/release-notes/ - title: Browse common FAQs description: Explore general FAQs or FAQs for specific platforms. icon: help link: /desktop/faqs/ - title: Find additional resources - description: Find information on networking features, deploying on Kubernetes, and - more. + description: | + Find information on networking features, deploying on Kubernetes, and more. icon: category - link: /desktop/kubernetes + link: /desktop/kubernetes/ - title: Give feedback description: Provide feedback on Docker Desktop or Docker Desktop features. icon: sms - link: /desktop/feedback + link: /desktop/feedback/ aliases: - /desktop/opensource/ - /docker-for-mac/dashboard/ @@ -52,17 +48,16 @@ It provides a straightforward GUI (Graphical User Interface) that lets you manag Docker Desktop reduces the time spent on complex setups so you can focus on writing code. It takes care of port mappings, file system concerns, and other default settings, and is regularly updated with bug fixes and security updates. - {{< tabs >}} {{< tab name="What's included in Docker Desktop?" >}} -- [Docker Engine](../engine/index.md) +- [Docker Engine](../engine/_index.md) - Docker CLI client - [Docker Scout](../scout/_index.md) (additional subscription may apply) -- [Docker Build](../build/index.md) -- [Docker Extensions](extensions/index.md) -- [Docker Compose](../compose/index.md) -- [Docker Content Trust](../engine/security/trust/index.md) +- [Docker Build](../build/_index.md) +- [Docker Extensions](./extensions/_index.md) +- [Docker Compose](../compose/_index.md) +- [Docker Content Trust](../engine/security/trust/_index.md) - [Kubernetes](https://github.com/kubernetes/kubernetes/) - [Credential Helper](https://github.com/docker/docker-credential-helpers/) diff --git a/content/desktop/extensions-sdk/design/mui-best-practices.md b/content/desktop/extensions-sdk/design/mui-best-practices.md index 59b10c0633..4de8039a4f 100644 --- a/content/desktop/extensions-sdk/design/mui-best-practices.md +++ b/content/desktop/extensions-sdk/design/mui-best-practices.md @@ -47,4 +47,4 @@ Some of the above options require you to extend our MUI theme. See the MUI docum ## What's next? - Take a look at our [UI styling guide](index.md). -- Learn how to [publish your extension](../extensions/index.md). \ No newline at end of file +- Learn how to [publish your extension](../extensions/index.md). diff --git a/content/desktop/extensions-sdk/quickstart.md b/content/desktop/extensions-sdk/quickstart.md index 5b9321b2ea..fd579608e5 100644 --- a/content/desktop/extensions-sdk/quickstart.md +++ b/content/desktop/extensions-sdk/quickstart.md @@ -90,4 +90,4 @@ $ docker extension rm - Learn how to [test and debug](dev/test-debug.md) your extension. - Learn how to [setup CI for your extension](dev/continuous-integration.md). - Learn more about extensions [architecture](architecture/index.md). -- Learn more about [designing the UI](design/design-guidelines.md). \ No newline at end of file +- Learn more about [designing the UI](design/design-guidelines.md). diff --git a/content/desktop/install/archlinux.md b/content/desktop/install/archlinux.md index e069538e4a..9c03a798f9 100644 --- a/content/desktop/install/archlinux.md +++ b/content/desktop/install/archlinux.md @@ -53,4 +53,4 @@ $ sudo pacman -S gnome-terminal - Take a look at the [Get started](../../get-started/index.md) training modules to learn how to build an image and run it as a containerized application. - [Explore Docker Desktop](../use-desktop/index.md) and all its features. -- Review the topics in [Develop with Docker](../../develop/index.md) to learn how to build new applications using Docker. \ No newline at end of file +- Review the topics in [Develop with Docker](../../develop/index.md) to learn how to build new applications using Docker. diff --git a/content/desktop/release-notes.md b/content/desktop/release-notes.md index 5c61f7693b..fa4111875b 100644 --- a/content/desktop/release-notes.md +++ b/content/desktop/release-notes.md @@ -2,6 +2,7 @@ description: Release notes for Docker Desktop for Mac, Linux, and Windows keywords: Docker desktop, release notes, linux, mac, windows title: Docker Desktop release notes +tags: [Release notes] toc_max: 2 aliases: - /docker-for-mac/release-notes/ diff --git a/content/desktop/troubleshoot/known-issues.md b/content/desktop/troubleshoot/known-issues.md index a53dd24b01..9cd6c21648 100644 --- a/content/desktop/troubleshoot/known-issues.md +++ b/content/desktop/troubleshoot/known-issues.md @@ -2,6 +2,7 @@ description: Find known issues for Docker Desktop keywords: mac, troubleshooting, known issues, Docker Desktop title: Known issues +tags: [ Troubleshooting ] --- {{< tabs >}} @@ -72,4 +73,4 @@ title: Known issues - `ping` from inside a container to the Internet does not work as expected. To test the network, use `curl` or `wget`. See [docker/for-mac#5322](https://github.com/docker/for-mac/issues/5322#issuecomment-809392861). - Users may occasionally experience data drop when a TCP stream is half-closed. {{< /tab >}} -{{< /tabs >}} \ No newline at end of file +{{< /tabs >}} diff --git a/content/desktop/troubleshoot/overview.md b/content/desktop/troubleshoot/overview.md index 6982af444d..7efee58036 100644 --- a/content/desktop/troubleshoot/overview.md +++ b/content/desktop/troubleshoot/overview.md @@ -13,6 +13,7 @@ aliases: - /windows/troubleshoot/ - /docker-for-win/troubleshoot/ - /docker-for-windows/troubleshoot/ +tags: [ Troubleshooting ] --- This page contains information on how to diagnose and troubleshoot Docker Desktop, and how to check the logs. @@ -312,4 +313,4 @@ to learn how to view the Docker Daemon logs. - View specific [troubleshoot topics](topics.md). - Implement [workarounds for common problems](workarounds.md) -- View information on [known issues](known-issues.md) \ No newline at end of file +- View information on [known issues](known-issues.md) diff --git a/content/desktop/troubleshoot/topics.md b/content/desktop/troubleshoot/topics.md index 62f59ac2e4..b98f230efa 100644 --- a/content/desktop/troubleshoot/topics.md +++ b/content/desktop/troubleshoot/topics.md @@ -3,6 +3,7 @@ description: Explore common troubleshooting topics for Docker Desktop keywords: Linux, Mac, Windows, troubleshooting, topics, Docker Desktop title: Troubleshoot topics for Docker Desktop toc_max: 4 +tags: [ Troubleshooting ] --- > **Tip** diff --git a/content/desktop/troubleshoot/workarounds.md b/content/desktop/troubleshoot/workarounds.md index 50feb4ad06..7af6aa899f 100644 --- a/content/desktop/troubleshoot/workarounds.md +++ b/content/desktop/troubleshoot/workarounds.md @@ -2,6 +2,7 @@ description: Common workarounds keywords: linux, mac, windows, troubleshooting, workarounds, Docker Desktop title: Workarounds for common problems +tags: [ Troubleshooting ] --- ### Reboot @@ -44,4 +45,4 @@ typically occurs after a Windows update and manifests as an error response from the Docker daemon and a Docker Desktop start failure. For a temporary workaround, uninstall the anti-virus software, or -explore other workarounds suggested on Docker Desktop forums. \ No newline at end of file +explore other workarounds suggested on Docker Desktop forums. diff --git a/content/desktop/wsl/best-practices.md b/content/desktop/wsl/best-practices.md index b4d8689fc2..37e36279f5 100644 --- a/content/desktop/wsl/best-practices.md +++ b/content/desktop/wsl/best-practices.md @@ -2,6 +2,7 @@ title: Best practices description: Best practices for using Docker Desktop with WSL 2 keywords: wsl, docker desktop, best practices +tags: [Best practices] --- - Always use the latest version of WSL. At a minimum you must use WSL version 1.1.3.0., otherwise Docker Desktop may not work as expected. Testing, development, and documentation is based on the newest kernel versions. Older versions of WSL can cause: @@ -17,4 +18,4 @@ keywords: wsl, docker desktop, best practices - Instead, from a Linux shell use a command like `docker run -v ~/my-project:/sources ` where `~` is expanded by the Linux shell to `$HOME`. - If you have concerns about the size of the docker-desktop-data VHDX, or need to change it, take a look at the [WSL tooling built into Windows](https://learn.microsoft.com/en-us/windows/wsl/disk-space). -- If you have concerns about CPU or memory usage, you can configure limits on the memory, CPU, and swap size allocated to the [WSL 2 utility VM](https://learn.microsoft.com/en-us/windows/wsl/wsl-config#global-configuration-options-with-wslconfig). \ No newline at end of file +- If you have concerns about CPU or memory usage, you can configure limits on the memory, CPU, and swap size allocated to the [WSL 2 utility VM](https://learn.microsoft.com/en-us/windows/wsl/wsl-config#global-configuration-options-with-wslconfig). diff --git a/content/develop/dev-best-practices.md b/content/develop/dev-best-practices.md index 99cb4ae0e2..2095b76010 100644 --- a/content/develop/dev-best-practices.md +++ b/content/develop/dev-best-practices.md @@ -2,6 +2,7 @@ title: Docker development best practices description: Rules of thumb for making your life easier as a Docker application developer keywords: application, development +tags: [Best practices] --- The following development patterns have proven to be helpful for people diff --git a/content/develop/develop-images/dockerfile_best-practices.md b/content/develop/develop-images/dockerfile_best-practices.md index 08cf2f7acd..f9be76c157 100644 --- a/content/develop/develop-images/dockerfile_best-practices.md +++ b/content/develop/develop-images/dockerfile_best-practices.md @@ -8,6 +8,7 @@ aliases: - /docker-cloud/getting-started/intermediate/optimize-dockerfiles/ - /docker-cloud/tutorials/optimize-dockerfiles/ - /engine/userguide/eng-image/dockerfile_best-practices/ +tags: [Best practices] --- This topic covers recommended best practices and methods for building diff --git a/content/develop/develop-images/guidelines.md b/content/develop/develop-images/guidelines.md index aadda5d3e4..2f712ffab8 100644 --- a/content/develop/develop-images/guidelines.md +++ b/content/develop/develop-images/guidelines.md @@ -2,6 +2,7 @@ description: Hints, tips and guidelines for writing clean, reliable Dockerfiles keywords: parent image, images, dockerfile, best practices, hub, official image title: General best practices for writing Dockerfiles +tags: [Best practices] --- ## Use multi-stage builds diff --git a/content/develop/security-best-practices.md b/content/develop/security-best-practices.md index d6474d408d..698b865a4d 100644 --- a/content/develop/security-best-practices.md +++ b/content/develop/security-best-practices.md @@ -4,6 +4,7 @@ description: Image security best practices guide keywords: docker, images, containers, vulnerability, cve aliases: - /develop/scan-images/ +tags: [Best practices] --- You can take a few steps to improve the security of your diff --git a/content/docker-hub/builds/troubleshoot.md b/content/docker-hub/builds/troubleshoot.md index 93a8f441f8..6f8739b8d4 100644 --- a/content/docker-hub/builds/troubleshoot.md +++ b/content/docker-hub/builds/troubleshoot.md @@ -2,6 +2,7 @@ title: Troubleshoot your autobuilds description: How to troubleshoot Automated builds keywords: docker hub, troubleshoot, automated builds, autobuilds +tags: [ Troubleshooting ] --- > **Note** @@ -66,4 +67,4 @@ system access to the repositories. > **Note** > > You must configure your private git submodules using git clone over SSH -> (`git@submodule.tld:some-submodule.git`) rather than HTTPS. \ No newline at end of file +> (`git@submodule.tld:some-submodule.git`) rather than HTTPS. diff --git a/content/docker-hub/quickstart.md b/content/docker-hub/quickstart.md index 000aecaa4e..d8b3dbb86d 100644 --- a/content/docker-hub/quickstart.md +++ b/content/docker-hub/quickstart.md @@ -216,4 +216,4 @@ You've successfully: - Automatically build container images from code through [builds](builds/index.md). - [Explore](https://hub.docker.com/explore) official & publisher images. - [Upgrade your subscription](https://www.docker.com/pricing) to push additional private Docker images to -Docker Hub. \ No newline at end of file +Docker Hub. diff --git a/content/docker-hub/release-notes.md b/content/docker-hub/release-notes.md index 40fe2c6d95..31d331b4a8 100644 --- a/content/docker-hub/release-notes.md +++ b/content/docker-hub/release-notes.md @@ -5,6 +5,7 @@ description: Learn about the new features, bug fixes, and breaking changes for D keywords: docker hub, whats new, release notes toc_min: 1 toc_max: 2 +tags: [Release notes] --- Here you can learn about the latest changes, new features, bug fixes, and diff --git a/content/engine/install/linux-postinstall.md b/content/engine/install/linux-postinstall.md index 4c46d3c446..7bd20dcadd 100644 --- a/content/engine/install/linux-postinstall.md +++ b/content/engine/install/linux-postinstall.md @@ -142,4 +142,4 @@ options: - Read the [Get started](../../get-started/index.md) training modules to learn how to build an image and run it as a containerized application. - Review the topics in [Develop with Docker](../../develop/index.md) to learn - how to build new applications using Docker. \ No newline at end of file + how to build new applications using Docker. diff --git a/content/engine/install/troubleshoot.md b/content/engine/install/troubleshoot.md index 999c2d77a9..857ada15ac 100644 --- a/content/engine/install/troubleshoot.md +++ b/content/engine/install/troubleshoot.md @@ -2,6 +2,7 @@ title: Troubleshoot Docker Engine installation description: Learn how to diagnose and resolve error messages related to the Docker Engine installation. keywords: Docker Engine, troubleshooting, error, Linux, install Docker Engine +tags: [ Troubleshooting ] --- This page contains instructions for troubleshooting and diagnosing the Docker @@ -288,4 +289,4 @@ Docker isn't running. An error occurs if your GRUB configuration file has incorrect syntax. In this case, repeat steps 2 and 3. - The changes take effect when you reboot the system. \ No newline at end of file + The changes take effect when you reboot the system. diff --git a/content/engine/swarm/secrets.md b/content/engine/swarm/secrets.md index e263ac3c2e..3e3df24030 100644 --- a/content/engine/swarm/secrets.md +++ b/content/engine/swarm/secrets.md @@ -3,6 +3,7 @@ title: Manage sensitive data with Docker secrets description: How to securely store, retrieve, and use sensitive data with Docker services keywords: swarm, secrets, credentials, sensitive strings, sensitive data, security, encryption, encryption at rest +tags: [Secrets] --- ## About secrets diff --git a/content/faq/_index.md b/content/faq/_index.md index 4bc187b6d4..ec3fa18c41 100644 --- a/content/faq/_index.md +++ b/content/faq/_index.md @@ -25,4 +25,4 @@ grid: Explore popular FAQ topics. -{{< grid >}} \ No newline at end of file +{{< grid >}} diff --git a/content/release-notes.md b/content/release-notes.md deleted file mode 100644 index 8d82b97949..0000000000 --- a/content/release-notes.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -description: Release notes for Docker -keywords: docker, documentation, about, technology, understanding, release, scout, desktop, hub, compose, build, engine -title: Release notes for Docker -grid: -- title: Docker Desktop - icon: web_asset - link: /desktop/release-notes/ -- title: Docker Engine - icon: developer_board - link: /engine/release-notes/ -- title: Docker Compose - icon: storage - link: /compose/release-notes/ -- title: Docker Build - icon: construction - link: /build/release-notes/ -- title: Docker Hub - icon: widgets - link: /docker-hub/release-notes/ -- title: Docker Scout (platform) - icon: query_stats - link: /scout/release-notes/platform/ -- title: Docker Scout (CLI) - icon: query_stats - link: /scout/release-notes/cli/ ---- - -Find out what's new in Docker. Release notes contain information about new -features, improvements, known issues, and bug fixes in each release. You can -find release notes for each component in the Manuals section. We suggest -that you regularly visit the release notes to learn about updates. - -{{< grid >}} diff --git a/content/scout/release-notes/platform.md b/content/scout/release-notes/platform.md index bfe3a60f54..7e8167174a 100644 --- a/content/scout/release-notes/platform.md +++ b/content/scout/release-notes/platform.md @@ -4,6 +4,7 @@ description: Learn about the latest features of Docker Scout keywords: docker scout, release notes, changelog, features, changes, delta, new, releases aliases: - /scout/release-notes/ +tags: [Release notes] --- This page contains information about the new features, improvements, known diff --git a/content/storage/troubleshooting_volume_errors.md b/content/storage/troubleshooting_volume_errors.md index bf0a68aaf4..164d377322 100644 --- a/content/storage/troubleshooting_volume_errors.md +++ b/content/storage/troubleshooting_volume_errors.md @@ -4,6 +4,7 @@ keywords: cadvisor, troubleshooting, volumes, bind-mounts title: Troubleshoot storage errors aliases: - /engine/admin/troubleshooting_volume_errors/ +tags: [ Troubleshooting ] --- This topic discusses errors which may occur when you use Docker volumes or bind @@ -58,4 +59,4 @@ $ sudo lsof /var/lib/docker/containers/74bef250361c7817bee19349c93139621b272bc8f ``` To work around this problem, stop the container which bind-mounts -`/var/lib/docker` and try again to remove the other container. \ No newline at end of file +`/var/lib/docker` and try again to remove the other container. diff --git a/content/tags/_index.md b/content/tags/_index.md new file mode 100644 index 0000000000..b502c2f650 --- /dev/null +++ b/content/tags/_index.md @@ -0,0 +1,5 @@ +--- +title: Tags +--- + +Here you can browse Docker docs by tag. diff --git a/content/tags/best-practices/_index.md b/content/tags/best-practices/_index.md new file mode 100644 index 0000000000..76591b1b2c --- /dev/null +++ b/content/tags/best-practices/_index.md @@ -0,0 +1,8 @@ +--- +title: Best practices +icon: star +description: Optimal patterns for Docker +--- + +Best practices articles describe methods and techniques that are generally +the most idiomatic and optimized way to do something. diff --git a/content/tags/release-notes/_index.md b/content/tags/release-notes/_index.md new file mode 100644 index 0000000000..3cafaa0a4f --- /dev/null +++ b/content/tags/release-notes/_index.md @@ -0,0 +1,10 @@ +--- +title: Release notes +icon: note_stack_add +description: Find out about the latest features +aliases: +- /release-notes/ +--- + +Release notes describe corrections, changes or enhancements made to a product +product in a given release. diff --git a/content/tags/secrets/_index.md b/content/tags/secrets/_index.md new file mode 100644 index 0000000000..383adbf49c --- /dev/null +++ b/content/tags/secrets/_index.md @@ -0,0 +1,11 @@ +--- +title: Secrets +icon: password +description: Use sensitive information in containers securely +--- + +A secret is a piece of data, such as a password, SSH private key, SSL +certificate, or anything that should not be transmitted over a network or +stored unencrypted in a Dockerfile or in your application's source code. + +Docker provides specially designated features for managing secrets. diff --git a/content/tags/troubleshooting/_index.md b/content/tags/troubleshooting/_index.md new file mode 100644 index 0000000000..16889090b8 --- /dev/null +++ b/content/tags/troubleshooting/_index.md @@ -0,0 +1,8 @@ +--- +title: Troubleshooting +icon: troubleshoot +description: Fix common issues +--- + +Troubleshooting articles contain guidelines for solving common problems and +pitfalls that you might encounter with Docker products. diff --git a/data/toc.yaml b/data/toc.yaml index c82d247d0d..6ed65c8c9c 100644 --- a/data/toc.yaml +++ b/data/toc.yaml @@ -2255,8 +2255,6 @@ Manuals: - path: /trusted-content/insights-analytics/ title: Insights and analytics -- path: /release-notes/ - title: Release notes - path: /support/ title: Get support - path: /release-lifecycle/ diff --git a/hugo.yaml b/hugo.yaml index e37c7e5036..de5e5cd586 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -4,9 +4,9 @@ refLinksErrorLevel: ERROR enableGitInfo: true disablePathToLower: true enableInlineShortcodes: true -disableKinds: - - taxonomy - - term + +taxonomies: + tag: tags markup: tableOfContents: diff --git a/hugo_stats.json b/hugo_stats.json index 5738f8fb0c..be6521c0f3 100644 --- a/hugo_stats.json +++ b/hugo_stats.json @@ -159,6 +159,7 @@ "dark:bg-blue-dark-400", "dark:bg-gray-dark-100", "dark:bg-gray-dark-200", + "dark:bg-gray-dark-300", "dark:bg-gray-dark-300/50", "dark:bg-gray-dark-400", "dark:bg-green-dark", @@ -186,6 +187,7 @@ "dark:text-gray-dark-500", "dark:text-gray-dark-600", "dark:text-gray-dark-700", + "dark:text-gray-dark-800", "dark:text-violet-dark", "dark:text-white", "dark:to-blue-dark-100", @@ -206,6 +208,7 @@ "flex-col-reverse", "flex-initial", "flex-row-reverse", + "flex-wrap", "font-medium", "footnote-backref", "footnote-ref", @@ -248,6 +251,7 @@ "hover:opacity-90", "hover:underline", "hub-api", + "icon-lg", "icon-sm", "icon-svg", "important", @@ -264,10 +268,14 @@ "justify-self-end", "leading-snug", "left-0", + "lg:block", "lg:grid-cols-2", "lg:grow-0", "lg:hidden", + "lg:link", + "lg:pb-0", "lg:px-4", + "lg:text-base", "lg:w-full", "link", "lntable", @@ -300,8 +308,10 @@ "ml-auto", "mt-1", "mt-20", + "mt-auto", "mx-auto", "my-0", + "my-2", "my-4", "no-underline", "no-wrap", @@ -319,6 +329,7 @@ "p-6", "p-8", "p-[2px]", + "pb-0.5", "pb-2", "pb-4", "pl-1", @@ -331,6 +342,7 @@ "pt-0", "px-1", "px-2", + "px-3", "px-4", "py-1", "py-2", @@ -393,6 +405,7 @@ "to-blue-light-500", "to-magenta-light-400", "to-transparent", + "toc", "top-0", "top-16", "top-3", diff --git a/layouts/_default/list.html b/layouts/_default/list.html index 857d46c2f5..4b2a1fba2b 100644 --- a/layouts/_default/list.html +++ b/layouts/_default/list.html @@ -8,6 +8,9 @@ {{ with .Title }}

{{ . }}

{{ end }} + {{ .Content }} {{ end }} diff --git a/layouts/_default/single.html b/layouts/_default/single.html index 857d46c2f5..615ddf4cfb 100644 --- a/layouts/_default/single.html +++ b/layouts/_default/single.html @@ -8,6 +8,10 @@ {{ with .Title }}

{{ . }}

{{ end }} + {{ .Content }} {{ end }} diff --git a/layouts/index.html b/layouts/index.html index b7b7b36ba9..5f4b1ce0ad 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -190,6 +190,16 @@ {{ end }} +
+

Browse by tag

+
+ {{ $tags := slice }} + {{- range site.Taxonomies.tags }} + {{ $tags = $tags | append .Page }} + {{ end }} + {{ partial "tags.html" $tags }} +
+
{{ partial "github-links.html" . }} - {{ partial "toc-default.html" . }} +
+ {{ partial "pagemeta.html" . }} +
diff --git a/layouts/partials/category-links.html b/layouts/partials/category-links.html new file mode 100644 index 0000000000..e69de29bb2 diff --git a/layouts/partials/pagemeta.html b/layouts/partials/pagemeta.html new file mode 100644 index 0000000000..36f29bd0ee --- /dev/null +++ b/layouts/partials/pagemeta.html @@ -0,0 +1,41 @@ +{{- $toc := false }} +{{- with .Fragments }} + {{- $toc = and (ne page.Params.notoc true) .Headings }} +{{- end }} +{{- $tags := .GetTerms "tags" }} +{{- if or $toc $tags }} +
+ {{- with $tags }} +
+ Tags +
+ {{- partial "tags.html" . -}} +
+
+ {{- end }} + {{- with $toc }} +
Table of contents
+ + {{- end }} +
+{{- end }} + +{{- define "walkHeadingFragments" }} + {{- $min := 2 }} + {{- $max := 3 }} +
    + {{- range . }} + {{- if and (ge .Level $min) (le .Level $max) }} +
  • + {{ .Title }} +
    • + {{- end }} + {{- with .Headings }} + {{ template "walkHeadingFragments" . }} + {{- end }} + {{- end }} +
+{{- end }} diff --git a/layouts/partials/pagination.html b/layouts/partials/pagination.html new file mode 100644 index 0000000000..a3f203e264 --- /dev/null +++ b/layouts/partials/pagination.html @@ -0,0 +1,70 @@ +{{- if gt .Paginator.TotalPages 1 }} + {{ $selectable := "cursor-pointer" }} + {{ $active := "hover:text-black dark:hover:text-white underline underline-offset-8" }} + {{ $disabled := "cursor-not-allowed text-gray-light dark:text-gray-dark" }} + +{{- end }} + diff --git a/layouts/partials/tags.html b/layouts/partials/tags.html new file mode 100644 index 0000000000..9846805e05 --- /dev/null +++ b/layouts/partials/tags.html @@ -0,0 +1,13 @@ +{{- /* + List of tag "chips" as links + Context: page.Pages + */ -}} +{{- range . -}} +{{- if eq .File nil }} + {{- errorf "[tags] Undefined tag: '%s' in %s" (urlize (strings.ToLower .Title)) page.File.Filename }} +{{- end }} + +
{{ partialCached "icon" .Params.icon .Params.icon }}
+
{{ .LinkTitle }}
+ +{{- end -}} diff --git a/layouts/partials/toc-default.html b/layouts/partials/toc-default.html deleted file mode 100644 index 4c06b1245b..0000000000 --- a/layouts/partials/toc-default.html +++ /dev/null @@ -1,8 +0,0 @@ -{{ if ne .Params.notoc true }} - {{ if gt (len .TableOfContents) 32 }} -
-
{{ T "tableOfContents" }}
- {{ .TableOfContents }} -
- {{ end }} -{{ end }} diff --git a/layouts/partials/top-nav.html b/layouts/partials/top-nav.html index 4098638e2b..adcfb2c324 100644 --- a/layouts/partials/top-nav.html +++ b/layouts/partials/top-nav.html @@ -4,7 +4,7 @@