Skip to content

Commit 9d975a9

Browse files
authored
ENGDOCS-2228 (#20940)
* ENGDOCS-2228 * fix build * title edits
1 parent 71c4fe8 commit 9d975a9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+194
-127
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ You can use Docker (surprise) to build and serve the files locally.
5252

5353
> [!IMPORTANT]
5454
> This requires Docker Desktop version **4.24** or later, or Docker Engine with Docker
55-
> Compose version [**2.22**](https://docs.docker.com/compose/file-watch/) or later.
55+
> Compose version [**2.22**](https://docs.docker.com/compose/how-tos/file-watch/) or later.
5656
5757
1. [Fork the docker/docs repository.](https://github.com/docker/docs/fork)
5858

content/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ grid:
5757
- text: "Try Docker Compose"
5858
url: "/compose/gettingstarted/"
5959
- text: "Release notes"
60-
url: "/compose/release-notes/"
60+
url: "/compose/releases/release-notes/"
6161
- title: Docker Hub
6262
icon: device_hub
6363
description: |

content/get-started/docker-concepts/running-containers/overriding-container-defaults.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ This command runs a Postgres container, sets an environment variable for passwor
198198

199199
## Additional resources
200200

201-
* [Ways to set environment variables with Compose](/compose/environment-variables/set-environment-variables/)
201+
* [Ways to set environment variables with Compose](/compose/how-tos/environment-variables/set-environment-variables/)
202202
* [What is a container](/get-started/docker-concepts/the-basics/what-is-a-container/)
203203

204204
## Next steps

content/get-started/docker-concepts/the-basics/what-is-docker-compose.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -136,4 +136,4 @@ This page was a brief introduction to Compose. In the following resources, you c
136136

137137
* [Overview of Docker Compose](/compose/)
138138
* [Overview of Docker Compose CLI](/compose/reference/)
139-
* [How Compose works](/compose/compose-application-model/)
139+
* [How Compose works](/compose/intro/compose-application-model/)

content/guides/language/cpp/develop.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ $ git clone https://github.com/Pradumnasaraf/c-plus-plus-docker.git
3030

3131
Use Compose Watch to automatically update your running Compose services as you
3232
edit and save your code. For more details about Compose Watch, see [Use Compose
33-
Watch](/manuals/compose/file-watch.md).
33+
Watch](/manuals/compose/how-tos/file-watch.md).
3434

3535
Open your `compose.yml` file in an IDE or text editor and then add the Compose Watch instructions. The following example shows how to add Compose Watch to your `compose.yml` file.
3636

@@ -67,7 +67,7 @@ In this section, you also learned how to use Compose Watch to automatically rebu
6767

6868
Related information:
6969
- [Compose file reference](/reference/compose-file/)
70-
- [Compose file watch](/manuals/compose/file-watch.md)
70+
- [Compose file watch](/manuals/compose/how-tos/file-watch.md)
7171
- [Multi-stage builds](/manuals/build/building/multi-stage.md)
7272

7373
## Next steps

content/guides/language/dotnet/develop.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ Press `ctrl+c` in the terminal to stop your application.
229229

230230
## Automatically update services
231231

232-
Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see [Use Compose Watch](/manuals/compose/file-watch.md).
232+
Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see [Use Compose Watch](/manuals/compose/how-tos/file-watch.md).
233233

234234
Open your `compose.yaml` file in an IDE or text editor and then add the Compose Watch instructions. The following is the updated `compose.yaml` file.
235235

@@ -387,7 +387,7 @@ database and persist data. You also learned how to use Compose Watch to automati
387387

388388
Related information:
389389
- [Compose file reference](/reference/compose-file/)
390-
- [Compose file watch](/manuals/compose/file-watch.md)
390+
- [Compose file watch](/manuals/compose/how-tos/file-watch.md)
391391
- [Multi-stage builds](/manuals/build/building/multi-stage.md)
392392

393393
## Next steps

content/guides/language/java/develop.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ Press `ctrl+c` in the terminal to stop your application.
265265

266266
Use Compose Watch to automatically update your running Compose services as you
267267
edit and save your code. For more details about Compose Watch, see
268-
[Use Compose Watch](/manuals/compose/file-watch.md).
268+
[Use Compose Watch](/manuals/compose/how-tos/file-watch.md).
269269

270270
Open your `docker-compose.yaml` file in an IDE or text editor and then add the
271271
Compose Watch instructions. The following is the updated `docker-compose.yaml`
@@ -340,7 +340,7 @@ In this section, you took a look at running a database locally and persisting th
340340
Related information:
341341

342342
- [Compose file reference](/reference/compose-file/)
343-
- [Compose Watch](/manuals/compose/file-watch.md)
343+
- [Compose Watch](/manuals/compose/how-tos/file-watch.md)
344344
- [Dockerfile reference](/reference/dockerfile/)
345345

346346
## Next steps

content/guides/language/php/develop.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ Press `ctrl+c` in the terminal to stop your application.
240240

241241
## Automatically update services
242242

243-
Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see [Use Compose Watch](/manuals/compose/file-watch.md).
243+
Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see [Use Compose Watch](/manuals/compose/how-tos/file-watch.md).
244244

245245
Open your `compose.yaml` file in an IDE or text editor and then add the Compose Watch instructions. The following is the updated `compose.yaml` file.
246246

@@ -422,7 +422,7 @@ database and persist data. You also learned how to use Compose Watch to automati
422422

423423
Related information:
424424
- [Compose file reference](/reference/compose-file/)
425-
- [Compose file watch](/manuals/compose/file-watch.md)
425+
- [Compose file watch](/manuals/compose/how-tos/file-watch.md)
426426
- [Dockerfile reference](/reference/dockerfile.md)
427427
- [Official Docker Image for PHP](https://hub.docker.com/_/php)
428428

content/guides/language/python/develop.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ Press `ctrl+c` in the terminal to stop your application.
473473

474474
Use Compose Watch to automatically update your running Compose services as you
475475
edit and save your code. For more details about Compose Watch, see [Use Compose
476-
Watch](/manuals/compose/file-watch.md).
476+
Watch](/manuals/compose/how-tos/file-watch.md).
477477

478478
Open your `compose.yaml` file in an IDE or text editor and then add the Compose
479479
Watch instructions. The following is the updated `compose.yaml` file.
@@ -562,7 +562,7 @@ database and persist data. You also learned how to use Compose Watch to automati
562562

563563
Related information:
564564
- [Compose file reference](/reference/compose-file/)
565-
- [Compose file watch](/manuals/compose/file-watch.md)
565+
- [Compose file watch](/manuals/compose/how-tos/file-watch.md)
566566
- [Multi-stage builds](/manuals/build/building/multi-stage.md)
567567

568568
## Next steps

content/guides/language/r/develop.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Press `ctrl+c` in the terminal to stop your application.
147147

148148
Use Compose Watch to automatically update your running Compose services as you
149149
edit and save your code. For more details about Compose Watch, see [Use Compose
150-
Watch](/manuals/compose/file-watch.md).
150+
Watch](/manuals/compose/how-tos/file-watch.md).
151151

152152
Lines 15 to 18 in the `compose.yaml` file contain properties that trigger Docker
153153
to rebuild the image when a file in the current working directory is changed:
@@ -213,7 +213,7 @@ database and persist data. You also learned how to use Compose Watch to automati
213213

214214
Related information:
215215
- [Compose file reference](/reference/compose-file/)
216-
- [Compose file watch](/manuals/compose/file-watch.md)
216+
- [Compose file watch](/manuals/compose/how-tos/file-watch.md)
217217
- [Multi-stage builds](/manuals/build/building/multi-stage.md)
218218

219219
## Next steps

content/guides/language/ruby/develop.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Press `ctrl+c` in the terminal to stop your application and run `docker compose
129129

130130
Use Compose Watch to automatically update your running Compose services as you
131131
edit and save your code. For more details about Compose Watch, see [Use Compose
132-
Watch](/manuals/compose/file-watch.md).
132+
Watch](/manuals/compose/how-tos/file-watch.md).
133133

134134
Open your `compose.yaml` file in an IDE or text editor and then add the Compose
135135
Watch instructions. The following is the updated `compose.yaml` file.
@@ -193,7 +193,7 @@ database and persist data. You also learned how to use Compose Watch to automati
193193

194194
Related information:
195195
- [Compose file reference](/reference/compose-file/)
196-
- [Compose file watch](/manuals/compose/file-watch.md)
196+
- [Compose file watch](/manuals/compose/how-tos/file-watch.md)
197197
- [Multi-stage builds](/manuals/build/building/multi-stage.md)
198198

199199
## Next steps

content/guides/language/rust/develop.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ secrets:
281281
file: db/password.txt
282282
```
283283
284-
Note that the file doesn't specify a network for those 2 services. When you use Compose, it automatically creates a network and connects the services to it. For more information see [Networking in Compose](/manuals/compose/networking.md).
284+
Note that the file doesn't specify a network for those 2 services. When you use Compose, it automatically creates a network and connects the services to it. For more information see [Networking in Compose](/manuals/compose/how-tos/networking.md).
285285
286286
Before you run the application using Compose, notice that this Compose file specifies a `password.txt` file to hold the database's password. You must create this file as it's not included in the source repository.
287287

content/guides/use-case/genai-pdf-bot/develop.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ To run Ollama in a container and provide GPU access:
148148
149149
> [!NOTE]
150150
>
151-
> For more details about the Compose instructions, see [Turn on GPU access with Docker Compose](/manuals/compose/gpu-support.md).
151+
> For more details about the Compose instructions, see [Turn on GPU access with Docker Compose](/manuals/compose/how-tos/gpu-support.md).
152152
153153
3. Add the ollama-pull service to your `compose.yaml` file. This service uses
154154
the `docker/genai:ollama-pull` image, based on the GenAI Stack's

content/guides/use-case/rag-ollama/develop.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ To run Ollama in a container and provide GPU access:
9696
```
9797

9898
> [!NOTE]
99-
> For more details about the Compose instructions, see [Turn on GPU access with Docker Compose](/manuals/compose/gpu-support.md).
99+
> For more details about the Compose instructions, see [Turn on GPU access with Docker Compose](/manuals/compose/how-tos/gpu-support.md).
100100

101101
3. Once the Ollama container is up and running it is possible to use the `download_model.sh` inside the `tools` folder with this command:
102102

content/guides/use-case/tensorflowjs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ Docker Compose is a tool for defining and running multi-container Docker
431431
applications. With Compose, you use a YAML file to configure your application's
432432
services, networks, and volumes. In this case, the application isn't a
433433
multi-container application, but Docker Compose has other useful features for
434-
development, like [Compose Watch](/manuals/compose/file-watch.md).
434+
development, like [Compose Watch](/manuals/compose/how-tos/file-watch.md).
435435

436436
The sample application doesn't have a Compose file yet. To create a Compose
437437
file, in the `TensorJS-Face-Detection` directory, create a text file named

content/learning-paths/docker-compose.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ This command starts only the services associated with the `dev` profile,
109109
leaving the rest inactive.
110110

111111
For more information on using profiles, see [Using profiles with
112-
Compose](/compose/profiles/).
112+
Compose](/compose/how-tos/profiles/).
113113

114114
### How can I enforce the database service to start up before the frontend service?
115115

@@ -127,7 +127,7 @@ before starting. This ensures the database is not only up but also ready to
127127
handle requests.
128128

129129
For more information on setting the startup order of your services, see
130-
[Control startup and shutdown order in Compose](/compose/startup-order/).
130+
[Control startup and shutdown order in Compose](/compose/how-tos/startup-order/).
131131

132132
### Can I use Compose to build a Docker image?
133133

@@ -166,9 +166,9 @@ tests or perform one-off tasks within that container.
166166

167167
- [Overview of Docker Compose CLI](/compose/reference/)
168168
- [Overview of Docker Compose](/compose/)
169-
- [How Compose works](/compose/compose-application-model/)
170-
- [Using profiles with Compose](/compose/profiles/)
171-
- [Control startup and shutdown order with Compose](/compose/startup-order/)
169+
- [How Compose works](/compose/intro/compose-application-model/)
170+
- [Using profiles with Compose](/compose/how-tos/profiles/)
171+
- [Control startup and shutdown order with Compose](/compose/how-tos/startup-order/)
172172
- [Compose Build Specification](/compose/compose-file/build/)
173173

174174
{{< /accordion >}}

content/manuals/compose/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ grid:
1515
- title: How Compose works
1616
description: Understand how Compose works
1717
icon: category
18-
link: /compose/compose-application-model/
18+
link: /compose/intro/compose-application-model/
1919
- title: Install Compose
2020
description: Follow the instructions on how to install Docker Compose.
2121
icon: download
@@ -41,7 +41,7 @@ grid:
4141
- title: Migrate to Compose V2
4242
description: Learn how to migrate from Compose V1 to V2
4343
icon: folder_delete
44-
link: /compose/migrate/
44+
link: /compose/releases/migrate/
4545
aliases:
4646
- /compose/cli-command/
4747
- /compose/networking/swarm/

content/manuals/compose/bridge/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: Understand what Compose Bridge is and how it can be useful
33
keywords: compose, orchestration, kubernetes, bridge
44
title: Overview of Compose Bridge
55
linkTitle: Compose Bridge
6-
weight: 180
6+
weight: 50
77
---
88

99
{{< include "compose-bridge-experimental.md" >}}

content/manuals/compose/gettingstarted.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ keywords: docker compose example, docker compose tutorial, how to use docker com
77
file, run a docker compose file
88
title: Docker Compose Quickstart
99
linkTitle: Quickstart
10-
weight: 40
10+
weight: 30
1111
---
1212

1313
This tutorial aims to introduce fundamental concepts of Docker Compose by guiding you through the development of a basic Python web application.
@@ -241,7 +241,7 @@ services:
241241

242242
Whenever a file is changed, Compose syncs the file to the corresponding location under `/code` inside the container. Once copied, the bundler updates the running application without a restart.
243243

244-
For more information on how Compose Watch works, see [Use Compose Watch](file-watch.md). Alternatively, see [Manage data in containers](/manuals/engine/storage/volumes.md) for other options.
244+
For more information on how Compose Watch works, see [Use Compose Watch](/manuals/compose/how-tos/file-watch.md). Alternatively, see [Manage data in containers](/manuals/engine/storage/volumes.md) for other options.
245245

246246
> [!NOTE]
247247
>
@@ -316,7 +316,7 @@ Using multiple Compose files lets you customize a Compose application for differ
316316

317317
4. Run `docker compose up` to build the app with the updated Compose files, and run it. You should see the `Hello world` message in your browser.
318318

319-
This is a simplified example, but it demonstrates the basic principle of `include` and how it can make it easier to modularize complex applications into sub-Compose files. For more information on `include` and working with multiple Compose files, see [Working with multiple Compose files](multiple-compose-files/_index.md).
319+
This is a simplified example, but it demonstrates the basic principle of `include` and how it can make it easier to modularize complex applications into sub-Compose files. For more information on `include` and working with multiple Compose files, see [Working with multiple Compose files](/manuals/compose/how-tos/multiple-compose-files/_index.md).
320320

321321
## Step 8: Experiment with some other commands
322322

@@ -349,6 +349,6 @@ This is a simplified example, but it demonstrates the basic principle of `includ
349349
## Where to go next
350350

351351
- Try the [Sample apps with Compose](https://github.com/docker/awesome-compose)
352-
- [Explore the full list of Compose commands](reference/_index.md)
352+
- [Explore the full list of Compose commands](/reference/cli/docker/compose.md)
353353
- [Explore the Compose file reference](/reference/compose-file/_index.md)
354354
- [Check out the Learning Docker Compose video on LinkedIn Learning](https://www.linkedin.com/learning/learning-docker-compose/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
build:
3+
render: never
4+
title: How-tos
5+
weight: 40
6+
---

content/manuals/compose/environment-variables/_index.md renamed to content/manuals/compose/how-tos/environment-variables/_index.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
22
title: Environment variables in Compose
3-
linkTitle: Environment variables
4-
weight: 60
3+
linkTitle: Use environment variables
4+
weight: 40
55
description: Explainer on the ways to set, use and manage environment variables in
66
Compose
77
keywords: compose, orchestration, environment, env file
8+
aliases:
9+
- /compose/environment-variables/
810
---
911

1012
By leveraging environment variables and interpolation in Docker Compose, you can create versatile and reusable configurations, making your Dockerized applications easier to manage and deploy across different environments.

content/manuals/compose/environment-variables/best-practices.md renamed to content/manuals/compose/how-tos/environment-variables/best-practices.md

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ description: Explainer on the best ways to set, use, and manage environment vari
55
Compose
66
keywords: compose, orchestration, environment, env file, environment variables
77
tags: [Best practices]
8+
weight: 50
9+
aliases:
10+
- /compose/environment-variables/best-practices/
811
---
912

1013
#### Handle sensitive information securely

content/manuals/compose/environment-variables/envvars-precedence.md renamed to content/manuals/compose/how-tos/environment-variables/envvars-precedence.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ linkTitle: Environment variables precedence
44
description: Scenario overview illustrating how environment variables are resolved
55
in Compose
66
keywords: compose, environment, env file
7+
weight: 20
78
aliases:
89
- /compose/envvars-precedence/
10+
- /compose/environment-variables/envvvars-precedence/
911
---
1012

1113
When the same environment variable is set in multiple sources, Docker Compose follows a precedence rule to determine the value for that variable in your container's environment.

content/manuals/compose/environment-variables/envvars.md renamed to content/manuals/compose/how-tos/environment-variables/envvars.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@ description: Compose pre-defined environment variables
33
keywords: fig, composition, compose, docker, orchestration, cli, reference
44
title: Set or change pre-defined environment variables in Docker Compose
55
linkTitle: Pre-defined environment variables
6+
weight: 30
67
aliases:
78
- /compose/reference/envvars/
9+
- /compose/environment-variables/envvars/
810
---
911

1012
Compose already comes with pre-defined environment variables. It also inherits common Docker CLI environment variables, such as `DOCKER_HOST` and `DOCKER_CONTEXT`. See [Docker CLI environment variable reference](/reference/cli/docker/#environment-variables) for details.
@@ -184,7 +186,7 @@ This is an opt-out variable. When turned off it deactivates the experimental fea
184186
## Unsupported in Compose V2
185187

186188
The following environment variables have no effect in Compose V2.
187-
For more information, see [Migrate to Compose V2](../migrate.md).
189+
For more information, see [Migrate to Compose V2](/manuals/compose/releases/migrate.md).
188190

189191
- `COMPOSE_API_VERSION`
190192
By default the API version is negotiated with the server. Use `DOCKER_API_VERSION`.

content/manuals/compose/environment-variables/set-environment-variables.md renamed to content/manuals/compose/how-tos/environment-variables/set-environment-variables.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ keywords: compose, orchestration, environment, environment variables, container
77
aliases:
88
- /compose/env/
99
- /compose/link-env-deprecated/
10+
- /compose/set-environment-variables/
1011
---
1112

1213
A container's environment is not set until there's an explicit entry in the service configuration to make this happen. With Compose, there are two ways you can set environment variables in your containers with your Compose file.

content/manuals/compose/environment-variables/variable-interpolation.md renamed to content/manuals/compose/how-tos/environment-variables/variable-interpolation.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ title: Set, use, and manage variables in a Compose file with interpolation
33
linkTitle: Interpolation
44
description: How to set, use, and manage variables in your Compose file with interpolation
55
keywords: compose, orchestration, environment, variables, interpolation
6+
weight: 40
67
aliases:
78
- /compose/env-file/
89
- /compose/environment-variables/env-file/
10+
- /compose/environment-variables/variable-interpolation/
911
---
1012

1113
A Compose file can use variables to offer more flexibility. If you want to quickly switch

content/manuals/compose/file-watch.md renamed to content/manuals/compose/how-tos/file-watch.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22
description: Use File watch to automatically update running services as you work
33
keywords: compose, file watch, experimental
44
title: Use Compose Watch
5-
weight: 80
5+
weight: 50
6+
aliases:
7+
- /compose/file-watch/
68
---
79

8-
{{< introduced compose 2.22.0 "release-notes.md#2220" >}}
10+
{{< introduced compose 2.22.0 "/manuals/compose/releases/release-notes.md#2220" >}}
911

1012
{{< include "compose/watch.md" >}}
1113

0 commit comments

Comments
 (0)