Skip to content

Commit a1774fe

Browse files
authored
Compose freshness (#22927)
<!--Delete sections as needed --> ## Description Freshness for Intro, install, quickstart ## Related issues or tickets <!-- Related issues, pull requests, or Jira tickets --> ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Technical review - [ ] Editorial review - [ ] Product review
1 parent 0b3fb9c commit a1774fe

File tree

9 files changed

+62
-49
lines changed

9 files changed

+62
-49
lines changed

content/manuals/compose/_index.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@ title: Docker Compose
33
weight: 30
44
description: Learn how to use Docker Compose to define and run multi-container applications
55
with this detailed introduction to the tool.
6-
keywords: docker compose, docker-compose, docker compose command, docker compose files,
7-
docker compose documentation, using docker compose, compose container, docker compose
8-
service
6+
keywords: docker compose, docker-compose, compose.yaml, docker compose command, multi-container applications, container orchestration, docker cli
97
params:
108
sidebar:
119
group: Open source
@@ -36,6 +34,10 @@ grid:
3634
Docker application.
3735
icon: polyline
3836
link: /reference/compose-file
37+
- title: Use Compose Bridge
38+
description: Transform your Compose configuration file into configuration files for different platforms, such as Kubernetes.
39+
icon: move_down
40+
link: /compose/bridge
3941
- title: Browse common FAQs
4042
description: Explore general FAQs and find out how to give feedback.
4143
icon: help
@@ -58,12 +60,12 @@ It is the key to unlocking a streamlined and efficient development and deploymen
5860
Compose simplifies the control of your entire application stack, making it easy to manage services, networks, and volumes in a single YAML configuration file. Then, with a single command, you create and start all the services
5961
from your configuration file.
6062

61-
Compose works in all environments; production, staging, development, testing, as
63+
Compose works in all environments - production, staging, development, testing, as
6264
well as CI workflows. It also has commands for managing the whole lifecycle of your application:
6365

64-
* Start, stop, and rebuild services
65-
* View the status of running services
66-
* Stream the log output of running services
67-
* Run a one-off command on a service
66+
- Start, stop, and rebuild services
67+
- View the status of running services
68+
- Stream the log output of running services
69+
- Run a one-off command on a service
6870

6971
{{< grid >}}

content/manuals/compose/gettingstarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Check out this tutorial on how to use Docker Compose from defining application
2+
description: Follow this hands-on tutorial to learn how to use Docker Compose from defining application
33
dependencies to experimenting with commands.
44
keywords: docker compose example, docker compose tutorial, how to use docker compose,
55
running docker compose, how to run docker compose, docker compose build image, docker

content/manuals/compose/install/_index.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
---
22
description: Learn how to install Docker Compose. Compose is available natively on
33
Docker Desktop, as a Docker Engine plugin, and as a standalone tool.
4-
keywords: install docker compose, docker compose install, install docker compose ubuntu,
5-
installing docker compose, docker compose download, docker compose not found, docker
6-
compose windows, how to install docker compose
4+
keywords: install docker compose, docker compose plugin, install compose linux, install docker desktop, docker compose windows, standalone docker compose, docker compose not found
75
title: Overview of installing Docker Compose
86
linkTitle: Install
97
weight: 20
@@ -18,7 +16,7 @@ This page summarizes the different ways you can install Docker Compose, dependin
1816

1917
## Installation scenarios
2018

21-
### Scenario one: Install Docker Desktop (Recommended)
19+
### Docker Desktop (Recommended)
2220

2321
The easiest and recommended way to get Docker Compose is to install Docker Desktop.
2422

@@ -33,7 +31,7 @@ Docker Desktop is available for:
3331
>
3432
> If you have already installed Docker Desktop, you can check which version of Compose you have by selecting **About Docker Desktop** from the Docker menu {{< inline-image src="../../desktop/images/whale-x.svg" alt="whale menu" >}}.
3533
36-
### Scenario two: Install the Docker Compose plugin (Linux only)
34+
### Plugin (Linux only)
3735

3836
> [!IMPORTANT]
3937
>
@@ -43,7 +41,7 @@ If you already have Docker Engine and Docker CLI installed, you can install the
4341
- [Using Docker's repository](linux.md#install-using-the-repository)
4442
- [Downloading and installing manually](linux.md#install-the-plugin-manually)
4543

46-
### Scenario three: Install the Docker Compose standalone (Legacy)
44+
### Standalone (Legacy)
4745

4846
> [!WARNING]
4947
>

content/manuals/compose/install/linux.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
---
2-
description: Download and install Docker Compose on Linux with this step-by-step handbook.
3-
This plugin can be installed manually or by using a repository.
4-
keywords: install docker compose linux, docker compose linux, docker compose plugin,
5-
docker-compose-plugin, linux install docker compose, install docker-compose linux,
6-
linux install docker-compose, linux docker compose, docker compose v2 linux, install
7-
docker compose on linux
2+
description: Step-by-step instructions for installing the Docker Compose plugin on Linux using a package repository or manual method.
3+
keywords: install docker compose linux, docker compose plugin, docker-compose-plugin linux, docker compose v2, docker compose manual install, linux docker compose
84
toc_max: 3
95
title: Install the Docker Compose plugin
106
linkTitle: Plugin
@@ -77,9 +73,9 @@ To update the Docker Compose plugin, run the following commands:
7773

7874
## Install the plugin manually
7975

80-
> [!IMPORTANT]
76+
> [!WARNING]
8177
>
82-
> This option requires you to manage upgrades manually. It is recommended that you set up Docker's repository for easier maintenance.
78+
> Manual installations don’t auto-update. For ease of maintenance, use the Docker repository method.
8379

8480
1. To download and install the Docker Compose CLI plugin, run:
8581

@@ -113,4 +109,8 @@ To update the Docker Compose plugin, run the following commands:
113109
```console
114110
$ docker compose version
115111
```
116-
112+
113+
## What's next?
114+
115+
- [Understand how Compose works](/manuals/compose/intro/compose-application-model.md)
116+
- [Try the Quickstart guide](/manuals/compose/gettingstarted.md)

content/manuals/compose/install/standalone.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Install the Docker Compose standalone
33
linkTitle: Standalone
4-
description: How to install Docker Compose - Other Scenarios
5-
keywords: compose, orchestration, install, installation, docker, documentation
4+
description: Instructions for installing the legacy Docker Compose standalone tool on Linux and Windows Server
5+
keywords: install docker-compose, standalone docker compose, docker-compose windows server, install docker compose linux, legacy compose install
66
toc_max: 3
77
weight: 20
88
---
@@ -12,7 +12,8 @@ This page contains instructions on how to install Docker Compose standalone on L
1212
> [!WARNING]
1313
>
1414
> The Docker Compose standalone uses the `-compose` syntax instead of the current standard syntax `compose`.
15-
> For example, you must type `docker-compose up` when using Docker Compose standalone, instead of `docker compose up`.
15+
> For example, you must type `docker-compose up` when using Docker Compose standalone, instead of `docker compose up`.
16+
> Use it only for backward compatibility.
1617
1718
## On Linux
1819

@@ -74,3 +75,8 @@ on Microsoft Windows Server](/manuals/engine/install/binaries.md#install-server-
7475
$ docker-compose.exe version
7576
Docker Compose version {{% param "compose_version" %}}
7677
```
78+
79+
## What's next?
80+
81+
- [Understand how Compose works](/manuals/compose/intro/compose-application-model.md)
82+
- [Try the Quickstart guide](/manuals/compose/gettingstarted.md)

content/manuals/compose/install/uninstall.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: How to uninstall Docker Compose
33
keywords: compose, orchestration, uninstall, uninstallation, docker, documentation
44
title: Uninstall Docker Compose
5+
linkTitle: Uninstall
56
---
67

78
How you uninstall Docker Compose depends on how it was installed. This guide covers uninstallation instructions for:
@@ -13,7 +14,7 @@ How you uninstall Docker Compose depends on how it was installed. This guide cov
1314

1415
If you want to uninstall Docker Compose and you have installed Docker Desktop, see [Uninstall Docker Desktop](/manuals/desktop/uninstall.md).
1516

16-
> [!NOTE]
17+
> [!WARNING]
1718
>
1819
> Unless you have other Docker instances installed on that specific environment, uninstalling Docker Desktop removes all Docker components, including Docker Engine, Docker CLI, and Docker Compose.
1920

content/manuals/compose/intro/compose-application-model.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: How Compose works
33
weight: 10
4-
description: Understand how Compose works and the Compose application model with an illustrative example
5-
keywords: compose, docker compose, compose specification, compose model
4+
description: Learn how Docker Compose works, from the application model to Compose files and CLI, whilst following a detailed example.
5+
keywords: docker compose, compose.yaml, docker compose model, compose cli, multi-container application, compose example
66
aliases:
77
- /compose/compose-file/02-model/
88
- /compose/compose-yaml-file/
@@ -21,7 +21,7 @@ Services communicate with each other through [networks](/reference/compose-file/
2121

2222
Services store and share persistent data into [volumes](/reference/compose-file/volumes.md). The Specification describes such a persistent data as a high-level filesystem mount with global options.
2323

24-
Some services require configuration data that is dependent on the runtime or platform. For this, the Specification defines a dedicated [configs](/reference/compose-file/configs.md) concept. From a service container point of view, configs are comparable to volumes, in that they are files mounted into the container. But the actual definition involves distinct platform resources and services, which are abstracted by this type.
24+
Some services require configuration data that is dependent on the runtime or platform. For this, the Specification defines a dedicated [configs](/reference/compose-file/configs.md) concept. From inside the container, configs behave like volumesthey’re mounted as files. However, configs are defined differently at the platform level.
2525

2626
A [secret](/reference/compose-file/secrets.md) is a specific flavor of configuration data for sensitive data that should not be exposed without security considerations. Secrets are made available to services as files mounted into their containers, but the platform-specific resources to provide sensitive data are specific enough to deserve a distinct concept and definition within the Compose Specification.
2727

@@ -55,7 +55,9 @@ If you want to reuse other Compose files, or factor out parts of your applicatio
5555

5656
## CLI
5757

58-
The Docker CLI lets you interact with your Docker Compose applications through the `docker compose` command, and its subcommands. Using the CLI, you can manage the lifecycle of your multi-container applications defined in the `compose.yaml` file. The CLI commands enable you to start, stop, and configure your applications effortlessly.
58+
The Docker CLI lets you interact with your Docker Compose applications through the `docker compose` command and its subcommands. If you're using Docker Desktop, the Docker Compose CLI is included by default.
59+
60+
Using the CLI, you can manage the lifecycle of your multi-container applications defined in the `compose.yaml` file. The CLI commands enable you to start, stop, and configure your applications effortlessly.
5961

6062
### Key commands
6163

@@ -101,11 +103,11 @@ Both services communicate with each other on an isolated back-tier network, whil
101103

102104
The example application is composed of the following parts:
103105

104-
- 2 services, backed by Docker images: `webapp` and `database`
105-
- 1 secret (HTTPS certificate), injected into the frontend
106-
- 1 configuration (HTTP), injected into the frontend
107-
- 1 persistent volume, attached to the backend
108-
- 2 networks
106+
- Two services, backed by Docker images: `webapp` and `database`
107+
- One secret (HTTPS certificate), injected into the frontend
108+
- One configuration (HTTP), injected into the frontend
109+
- One persistent volume, attached to the backend
110+
- Two networks
109111

110112
```yml
111113
services:
@@ -162,6 +164,6 @@ example-backend-1 example/database "docker-entrypoint.s…" backend
162164

163165
## What's next
164166

165-
- [Quickstart](/manuals/compose/gettingstarted.md)
167+
- [Try the Quickstart guide](/manuals/compose/gettingstarted.md)
166168
- [Explore some sample applications](/manuals/compose/support-and-feedback/samples-for-compose.md)
167169
- [Familiarize yourself with the Compose Specification](/reference/compose-file/_index.md)

content/manuals/compose/intro/features-uses.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
description: Key benefits and use cases of Docker Compose
3-
keywords: documentation, docs, docker, compose, orchestration, containers, uses, benefits
2+
description: Discover the benefits and typical use cases of Docker Compose for containerized application development and deployment
3+
keywords: docker compose, compose use cases, compose benefits, container orchestration, development environments, testing containers, yaml file
44
title: Why use Compose?
55
weight: 20
66
aliases:
@@ -11,16 +11,14 @@ aliases:
1111

1212
Using Docker Compose offers several benefits that streamline the development, deployment, and management of containerized applications:
1313

14-
- Simplified control: Docker Compose allows you to define and manage multi-container applications in a single YAML file. This simplifies the complex task of orchestrating and coordinating various services, making it easier to manage and replicate your application environment.
14+
- Simplified control: Define and manage multi-container apps in one YAML file, streamlining orchestration and replication.
1515

16-
- Efficient collaboration: Docker Compose configuration files are easy to share, facilitating collaboration among developers, operations teams, and other stakeholders. This collaborative approach leads to smoother workflows, faster issue resolution, and increased overall efficiency.
16+
- Efficient collaboration: Shareable YAML files support smooth collaboration between developers and operations, improving workflows and issue resolution, leading to increased overall efficiency.
1717

1818
- Rapid application development: Compose caches the configuration used to create a container. When you restart a service that has not changed, Compose re-uses the existing containers. Re-using containers means that you can make changes to your environment very quickly.
1919

2020
- Portability across environments: Compose supports variables in the Compose file. You can use these variables to customize your composition for different environments, or different users.
2121

22-
- Extensive community and support: Docker Compose benefits from a vibrant and active community, which means abundant resources, tutorials, and support. This community-driven ecosystem contributes to the continuous improvement of Docker Compose and helps users troubleshoot issues effectively.
23-
2422
## Common use cases of Docker Compose
2523

2624
Compose can be used in many different ways. Some common use cases are outlined
@@ -67,4 +65,4 @@ For details on using production-oriented features, see
6765

6866
- [Learn about the history of Compose](history.md)
6967
- [Understand how Compose works](compose-application-model.md)
70-
- [Quickstart](../gettingstarted.md)
68+
- [Try the Quickstart guide](../gettingstarted.md)

content/manuals/compose/intro/history.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: History and development of Docker Compose
33
linkTitle: History and development
4-
description: History of Compose v1 and Compose YAML schema versioning
4+
description: Explore the evolution of Docker Compose from v1 to v2, including CLI changes, YAML versioning, and the Compose Specification.
55
keywords: compose, compose yaml, swarm, migration, compatibility, docker compose vs docker-compose
66
weight: 30
77
aliases:
@@ -11,7 +11,7 @@ aliases:
1111
This page provides:
1212
- A brief history of the development of the Docker Compose CLI
1313
- A clear explanation of the major versions and file formats that make up Compose v1 and Compose v2
14-
- The main differences between Compose V1 and Compose v2
14+
- The main differences between Compose v1 and Compose v2
1515

1616
## Introduction
1717

@@ -24,7 +24,7 @@ It also provides a quick snapshot of the differences in file formats, command-li
2424
### Docker Compose CLI versioning
2525

2626
Version one of the Docker Compose command-line binary was first released in 2014. It was written in Python, and is invoked with `docker-compose`.
27-
Typically, Compose V1 projects include a top-level `version` element in the `compose.yaml` file, with values ranging from `2.0` to `3.8`, which refer to the specific [file formats](#compose-file-format-versioning).
27+
Typically, Compose v1 projects include a top-level `version` element in the `compose.yaml` file, with values ranging from `2.0` to `3.8`, which refer to the specific [file formats](#compose-file-format-versioning).
2828

2929
Version two of the Docker Compose command-line binary was announced in 2020, is written in Go, and is invoked with `docker compose`.
3030
Compose v2 ignores the `version` top-level element in the `compose.yaml` file.
@@ -33,7 +33,7 @@ Compose v2 ignores the `version` top-level element in the `compose.yaml` file.
3333

3434
The Docker Compose CLIs are defined by specific file formats.
3535

36-
Three major versions of the Compose file format for Compose V1 were released:
36+
Three major versions of the Compose file format for Compose v1 were released:
3737
- Compose file format 1 with Compose 1.0.0 in 2014
3838
- Compose file format 2.x with Compose 1.6.0 in 2016
3939
- Compose file format 3.x with Compose 1.10.0 in 2017
@@ -48,3 +48,9 @@ To address confusion around Compose CLI versioning, Compose file format versioni
4848
Compose v2 uses the Compose Specification for project definition. Unlike the prior file formats, the Compose Specification is rolling and makes the `version` top-level element optional. Compose v2 also makes use of optional specifications - [Deploy](/reference/compose-file/deploy.md), [Develop](/reference/compose-file/develop.md), and [Build](/reference/compose-file/build.md).
4949

5050
To make [migration](/manuals/compose/releases/migrate.md) easier, Compose v2 has backwards compatibility for certain elements that have been deprecated or changed between Compose file format 2.x/3.x and the Compose Specification.
51+
52+
## What's next?
53+
54+
- [How Compose works](compose-application-model.md)
55+
- [Compose Specification reference](/reference/compose-file/_index.md)
56+
- [Migrate from Compose v1 to v2](/manuals/compose/releases/migrate.md)

0 commit comments

Comments
 (0)