From f62d925a50f11aee9cef6f33e4bd215729143aaa Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 18 Jun 2026 11:06:11 +0200 Subject: [PATCH 1/2] docs: remove unused includes and fix broken include references Delete 10 orphaned files under content/includes that are no longer referenced by any page via the include shortcode: - aci-ecs-eol.md, compose-eol.md, dev-envs-changing.md, dockerfile-labs-channel.md (stale EOL/status callouts) - buildx-v0.10-disclaimer.md, experimental.md, deploy.md, guides-get-docker.md, open-terminal.md (orphaned snippets) - labspace-quickstart.md (empty) Also fix two broken include references: - scout-early-access.md was deleted in 737ad3c4be but two environment integration pages still included it; remove the dangling lines. - reference/compose-file/develop.md included compose/develop.md, which does not exist; point it at the real file, compose/services-develop.md. Every include file is now referenced, and every reference resolves. Co-Authored-By: Claude Opus 4.8 (1M context) --- content/includes/aci-ecs-eol.md | 3 -- content/includes/buildx-v0.10-disclaimer.md | 8 ------ content/includes/compose-eol.md | 5 ---- content/includes/deploy.md | 28 ------------------- content/includes/dev-envs-changing.md | 5 ---- content/includes/dockerfile-labs-channel.md | 3 -- content/includes/experimental.md | 7 ----- content/includes/guides-get-docker.md | 1 - content/includes/labspace-quickstart.md | 0 content/includes/open-terminal.md | 10 ------- .../scout/integrations/environment/cli.md | 2 -- .../scout/integrations/environment/sysdig.md | 2 -- content/reference/compose-file/develop.md | 2 +- 13 files changed, 1 insertion(+), 75 deletions(-) delete mode 100644 content/includes/aci-ecs-eol.md delete mode 100644 content/includes/buildx-v0.10-disclaimer.md delete mode 100644 content/includes/compose-eol.md delete mode 100644 content/includes/deploy.md delete mode 100644 content/includes/dev-envs-changing.md delete mode 100644 content/includes/dockerfile-labs-channel.md delete mode 100644 content/includes/experimental.md delete mode 100644 content/includes/guides-get-docker.md delete mode 100644 content/includes/labspace-quickstart.md delete mode 100644 content/includes/open-terminal.md diff --git a/content/includes/aci-ecs-eol.md b/content/includes/aci-ecs-eol.md deleted file mode 100644 index b106ceb438..0000000000 --- a/content/includes/aci-ecs-eol.md +++ /dev/null @@ -1,3 +0,0 @@ -> [!IMPORTANT] -> -> Docker Compose's integration for ECS and ACI is retiring in November 2023. diff --git a/content/includes/buildx-v0.10-disclaimer.md b/content/includes/buildx-v0.10-disclaimer.md deleted file mode 100644 index 855bc5f58b..0000000000 --- a/content/includes/buildx-v0.10-disclaimer.md +++ /dev/null @@ -1,8 +0,0 @@ -> [!NOTE] -> -> Buildx v0.10 enables support for a minimal [SLSA Provenance](https://slsa.dev/provenance/) -> attestation, which requires support for [OCI-compliant](https://github.com/opencontainers/image-spec) -> multi-platform images. This may introduce issues with registry and runtime support -> (e.g. [Google Cloud Run and AWS Lambda](https://github.com/docker/buildx/issues/1533)). -> You can optionally disable the default provenance attestation functionality -> using `--provenance=false`. diff --git a/content/includes/compose-eol.md b/content/includes/compose-eol.md deleted file mode 100644 index ce5ad8fab9..0000000000 --- a/content/includes/compose-eol.md +++ /dev/null @@ -1,5 +0,0 @@ -> [!IMPORTANT] -> -> Docker's documentation refers to and describes Compose V2 functionality. -> -> Effective July 2023, Compose V1 stopped receiving updates and is no longer in new Docker Desktop releases. Compose V2 has replaced it and is now integrated into all current Docker Desktop versions. diff --git a/content/includes/deploy.md b/content/includes/deploy.md deleted file mode 100644 index 22702a8684..0000000000 --- a/content/includes/deploy.md +++ /dev/null @@ -1,28 +0,0 @@ -Now that we have configured a CI/CD pipeline, let's look at how we can deploy the application. Docker supports deploying containers on Azure ACI and AWS ECS. You can also deploy your application to Kubernetes if you have enabled Kubernetes in Docker Desktop. - -## Docker and Azure ACI - -The Docker Azure Integration enables developers to use native Docker commands to run applications in Azure Container Instances (ACI) when building cloud-native applications. The new experience provides a tight integration between Docker Desktop and Microsoft Azure allowing developers to quickly run applications using the Docker CLI or VS Code extension to switch seamlessly from local development to cloud deployment. - -For detailed instructions, see [Deploying Docker containers on Azure](/cloud/aci-integration/). - -## Docker and AWS ECS - -The Docker ECS Integration enables developers to use native Docker commands in the Docker Compose CLI to run applications in an Amazon EC2 Container Service (ECS) when building cloud-native applications. - -The integration between Docker and Amazon ECS allows developers to use the Docker Compose CLI to set up an AWS context in one Docker command, allowing them to switch from a local context to a cloud context and run applications quickly and easily to simplify multi-container application development on Amazon ECS using Compose files. - -For detailed instructions, see [Deploying Docker containers on ECS](/cloud/ecs-integration/). - -## Kubernetes - -Docker Desktop includes a standalone Kubernetes server and client, as well as Docker CLI integration that runs on your machine. When you enable Kubernetes, you can test your workloads on Kubernetes. - -To enable Kubernetes: - -1. From the Docker menu, select **Settings**. -2. Select **Kubernetes** and click **Enable Kubernetes**. - - This starts a Kubernetes single-node cluster when Docker Desktop starts. - -For detailed information, see [Deploy on Kubernetes](/manuals/desktop/use-desktop/kubernetes.md) and [Describing apps using Kubernetes YAML](/guides/deployment-orchestration/kube-deploy/#describing-apps-using-kubernetes-yaml). diff --git a/content/includes/dev-envs-changing.md b/content/includes/dev-envs-changing.md deleted file mode 100644 index edd3984a57..0000000000 --- a/content/includes/dev-envs-changing.md +++ /dev/null @@ -1,5 +0,0 @@ -> [!IMPORTANT] -> -> Dev Environments is no longer under active development. -> -> While the current functionality remains available, it may take us longer to respond to support requests. diff --git a/content/includes/dockerfile-labs-channel.md b/content/includes/dockerfile-labs-channel.md deleted file mode 100644 index 8a7bca00d1..0000000000 --- a/content/includes/dockerfile-labs-channel.md +++ /dev/null @@ -1,3 +0,0 @@ -> [!IMPORTANT] -> -> The labs channel gives you access to experimental Dockerfile features not yet available in the stable channel. \ No newline at end of file diff --git a/content/includes/experimental.md b/content/includes/experimental.md deleted file mode 100644 index 86cebbd3f9..0000000000 --- a/content/includes/experimental.md +++ /dev/null @@ -1,7 +0,0 @@ -Experimental features provide early access to future product functionality. -These features are intended for testing and feedback only as they may change -between releases without warning or can be removed entirely from a future -release. Experimental features must not be used in production environments. -Docker does not offer support for experimental features. - -For a list of current experimental features in the Docker CLI, see [Docker CLI Experimental features](https://github.com/docker/cli/blob/master/experimental/README.md). diff --git a/content/includes/guides-get-docker.md b/content/includes/guides-get-docker.md deleted file mode 100644 index 0a5ae3a13a..0000000000 --- a/content/includes/guides-get-docker.md +++ /dev/null @@ -1 +0,0 @@ -Before you start, get the latest version of [Docker Desktop](/get-started/get-docker.md). Docker adds new features regularly and some parts of this guide may work only with the latest version of Docker Desktop. diff --git a/content/includes/labspace-quickstart.md b/content/includes/labspace-quickstart.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/content/includes/open-terminal.md b/content/includes/open-terminal.md deleted file mode 100644 index 845154bc21..0000000000 --- a/content/includes/open-terminal.md +++ /dev/null @@ -1,10 +0,0 @@ -> [!TIP] -> -> To run Docker commands, you must use a terminal. Based on your -> operating system, you can open a terminal by doing the following: -> -> For Windows, select the Start Menu, specify `cmd`, and then select -> **Command Prompt**. -> -> For Mac, select the **Launchpad** icon in the Dock, specify `Terminal` in the -> search field, then select **Terminal**. diff --git a/content/manuals/scout/integrations/environment/cli.md b/content/manuals/scout/integrations/environment/cli.md index 9ed416c9a3..c4dfb1665d 100644 --- a/content/manuals/scout/integrations/environment/cli.md +++ b/content/manuals/scout/integrations/environment/cli.md @@ -5,8 +5,6 @@ title: Generic environment integration with CLI linkTitle: Generic (CLI) --- -{{% include "scout-early-access.md" %}} - You can create a generic environment integration by running the Docker Scout CLI client in your CI workflows. The CLI client is available as a binary on GitHub and as a container image on Docker Hub. Use the client to invoke the diff --git a/content/manuals/scout/integrations/environment/sysdig.md b/content/manuals/scout/integrations/environment/sysdig.md index 84415426b2..459c959822 100644 --- a/content/manuals/scout/integrations/environment/sysdig.md +++ b/content/manuals/scout/integrations/environment/sysdig.md @@ -5,8 +5,6 @@ description: Integrate your runtime environments with Docker Scout using Sysdig keywords: scout, sysdig, integration, image analysis, environments, supply chain --- -{{% include "scout-early-access.md" %}} - The Sysdig integration enables Docker Scout to automatically detect the images you're using for your running workloads. Activating this integration gives you real-time insights about your security posture, and lets you compare your diff --git a/content/reference/compose-file/develop.md b/content/reference/compose-file/develop.md index 4f49b0fa01..4fd1edab77 100644 --- a/content/reference/compose-file/develop.md +++ b/content/reference/compose-file/develop.md @@ -11,7 +11,7 @@ weight: 150 > > Develop is an optional part of the Compose Specification. It is available with Docker Compose version 2.22.0 and later. -{{% include "compose/develop.md" %}} +{{% include "compose/services-develop.md" %}} This page defines how Compose behaves to efficiently assist you and defines the development constraints and workflows set by Compose. Only a subset of Compose file services may require a `develop` subsection. From 482519b7d1496c5ca79ec0e0a7c3f0926b308c8f Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 18 Jun 2026 11:08:24 +0200 Subject: [PATCH 2/2] hugo: fail the build on broken include references The include shortcode previously called readFile directly, which renders nothing when the target is missing instead of failing. That let renamed or deleted snippets linger as silent no-ops (for example the stale scout-early-access.md and compose/develop.md references). Check fileExists first and errorf with the shortcode position when the target is missing, mirroring the file/files shortcodes. Verified against Hugo 0.163.0: valid includes still render; a missing target now fails the build with the offending file and line. Co-Authored-By: Claude Opus 4.8 (1M context) --- layouts/_shortcodes/include.html | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/layouts/_shortcodes/include.html b/layouts/_shortcodes/include.html index 8beb853f2b..2faab47dd2 100644 --- a/layouts/_shortcodes/include.html +++ b/layouts/_shortcodes/include.html @@ -1,3 +1,17 @@ +{{/* + include shortcode — inlines a reusable snippet from content/includes. + + Usage: + {{% include "root-errors.md" %}} + {{% include "compose/services.md" %}} + + The argument is a path relative to content/includes. The build fails with + a clear message if the target does not exist, so a renamed or deleted + snippet surfaces immediately instead of silently rendering nothing. +*/}} {{ $fileToInclude := .Get 0 }} {{ $filePath := printf "includes/%s" $fileToInclude }} -{{ readFile $filePath | safeHTML }} \ No newline at end of file +{{ if not (fileExists $filePath) }} + {{- errorf "include shortcode: file %q not found: %s" $filePath .Position -}} +{{ end }} +{{ readFile $filePath | safeHTML }}