diff --git a/docs/reference/compose.md b/docs/reference/compose.md index 052124bbe..46df7b832 100644 --- a/docs/reference/compose.md +++ b/docs/reference/compose.md @@ -57,7 +57,7 @@ Define and run multi-container applications with Docker. ## Description -You can use compose subcommand, `docker compose [-f ...] [options] [COMMAND] [ARGS...]`, to build and manage +You can use the compose subcommand, `docker compose [-f ...] [options] [COMMAND] [ARGS...]`, to build and manage multiple services in Docker containers. ### Use `-f` to specify the name and path of one or more Compose files @@ -146,16 +146,16 @@ demo_1 | 64 bytes from 127.0.0.1: seq=0 ttl=64 time=0.095 ms ### Use profiles to enable optional services Use `--profile` to specify one or more active profiles -Calling `docker compose --profile frontend up` will start the services with the profile `frontend` and services +Calling `docker compose --profile frontend up` starts the services with the profile `frontend` and services without any specified profiles. -You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` will be enabled. +You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` is enabled. Profiles can also be set by `COMPOSE_PROFILES` environment variable. ### Configuring parallelism Use `--parallel` to specify the maximum level of parallelism for concurrent engine calls. -Calling `docker compose --parallel 1 pull` will pull the pullable images defined in the Compose file +Calling `docker compose --parallel 1 pull` pulls the pullable images defined in the Compose file one at a time. This can also be used to control build concurrency. Parallelism can also be set by the `COMPOSE_PARALLEL_LIMIT` environment variable. @@ -171,7 +171,7 @@ and `COMPOSE_PARALLEL_LIMIT` does the same as the `--parallel` flag. If flags are explicitly set on the command line, the associated environment variable is ignored. -Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned +Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` stops docker compose from detecting orphaned containers for the project. ### Use Dry Run mode to test your command diff --git a/docs/reference/compose_alpha_dry-run.md b/docs/reference/compose_alpha_dry-run.md index a66ed5340..9e8350e2a 100644 --- a/docs/reference/compose_alpha_dry-run.md +++ b/docs/reference/compose_alpha_dry-run.md @@ -1,7 +1,7 @@ # docker compose alpha dry-run -EXPERIMENTAL - Dry run command allow you to test a command without applying changes +Dry run command allows you to test a command without applying changes. diff --git a/docs/reference/compose_alpha_scale.md b/docs/reference/compose_alpha_scale.md index 3cda50e20..15536b359 100644 --- a/docs/reference/compose_alpha_scale.md +++ b/docs/reference/compose_alpha_scale.md @@ -1,14 +1,14 @@ # docker compose alpha scale -Scale services +Scale services. ### Options | Name | Type | Default | Description | |:------------|:-----|:--------|:--------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--no-deps` | | | Don't start linked services. | +| `--no-deps` | | | Don't start linked services | diff --git a/docs/reference/compose_config.md b/docs/reference/compose_config.md index 15612ea33..2639cd735 100644 --- a/docs/reference/compose_config.md +++ b/docs/reference/compose_config.md @@ -31,6 +31,6 @@ Parse, resolve and render compose file in canonical format ## Description -`docker compose config` renders the actual data model to be applied on the Docker engine. -it merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into +`docker compose config` renders the actual data model to be applied on the Docker Engine. +It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into the canonical format. diff --git a/docs/reference/compose_down.md b/docs/reference/compose_down.md index 92d10389d..4012b70ca 100644 --- a/docs/reference/compose_down.md +++ b/docs/reference/compose_down.md @@ -22,12 +22,12 @@ Stops containers and removes containers, networks, volumes, and images created b By default, the only things removed are: -- Containers for services defined in the Compose file -- Networks defined in the networks section of the Compose file -- The default network, if one is used +- Containers for services defined in the Compose file. +- Networks defined in the networks section of the Compose file. +- The default network, if one is used. Networks and volumes defined as external are never removed. -Anonymous volumes are not removed by default. However, as they don’t have a stable name, they will not be automatically +Anonymous volumes are not removed by default. However, as they don’t have a stable name, they are not automatically mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or named volumes. diff --git a/docs/reference/compose_ps.md b/docs/reference/compose_ps.md index 401ec7a28..b73cae5d7 100644 --- a/docs/reference/compose_ps.md +++ b/docs/reference/compose_ps.md @@ -29,7 +29,7 @@ NAME IMAGE COMMAND SERVICE CREATED STATUS example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp ``` -By default, only running containers are shown. `--all` flag can be used to include stopped containers +By default, only running containers are shown. `--all` flag can be used to include stopped containers. ```console $ docker compose ps --all @@ -53,7 +53,7 @@ $ docker compose ps --format json ``` The JSON output allows you to use the information in other tools for further -processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/){:target="_blank" rel="noopener" class="_"} +processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/) to pretty-print the JSON: ```console diff --git a/docs/reference/compose_pull.md b/docs/reference/compose_pull.md index e68328fa7..03be4de05 100644 --- a/docs/reference/compose_pull.md +++ b/docs/reference/compose_pull.md @@ -25,7 +25,7 @@ those images. ## Examples -suppose you have this `compose.yaml`: +Consider the following `compose.yaml`: ```yaml services: @@ -66,5 +66,4 @@ $ docker compose pull db ⠹ c8752d5b785c Waiting 9.3s ``` -`docker compose pull` will try to pull image for services with a build section. If pull fails, it will let -user know this service image MUST be built. You can skip this by setting `--ignore-buildable` flag +`docker compose pull` tries to pull image for services with a build section. If pull fails, it lets you know this service image must be built. You can skip this by setting `--ignore-buildable` flag. diff --git a/docs/reference/compose_restart.md b/docs/reference/compose_restart.md index 973851ab5..1e7bdf3c8 100644 --- a/docs/reference/compose_restart.md +++ b/docs/reference/compose_restart.md @@ -23,6 +23,6 @@ after running this command. For example, changes to environment variables (which after a container is built, but before the container's command is executed) are not updated after restarting. -If you are looking to configure a service's restart policy, please refer to +If you are looking to configure a service's restart policy, refer to [restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart) or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy). diff --git a/docs/reference/docker_compose.yaml b/docs/reference/docker_compose.yaml index b6f5d76c5..c096f8923 100644 --- a/docs/reference/docker_compose.yaml +++ b/docs/reference/docker_compose.yaml @@ -1,7 +1,7 @@ command: docker compose short: Docker Compose long: |- - You can use compose subcommand, `docker compose [-f ...] [options] [COMMAND] [ARGS...]`, to build and manage + You can use the compose subcommand, `docker compose [-f ...] [options] [COMMAND] [ARGS...]`, to build and manage multiple services in Docker containers. ### Use `-f` to specify the name and path of one or more Compose files @@ -90,16 +90,16 @@ long: |- ### Use profiles to enable optional services Use `--profile` to specify one or more active profiles - Calling `docker compose --profile frontend up` will start the services with the profile `frontend` and services + Calling `docker compose --profile frontend up` starts the services with the profile `frontend` and services without any specified profiles. - You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` will be enabled. + You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` is enabled. Profiles can also be set by `COMPOSE_PROFILES` environment variable. ### Configuring parallelism Use `--parallel` to specify the maximum level of parallelism for concurrent engine calls. - Calling `docker compose --parallel 1 pull` will pull the pullable images defined in the Compose file + Calling `docker compose --parallel 1 pull` pulls the pullable images defined in the Compose file one at a time. This can also be used to control build concurrency. Parallelism can also be set by the `COMPOSE_PARALLEL_LIMIT` environment variable. @@ -115,7 +115,7 @@ long: |- If flags are explicitly set on the command line, the associated environment variable is ignored. - Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned + Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` stops docker compose from detecting orphaned containers for the project. ### Use Dry Run mode to test your command diff --git a/docs/reference/docker_compose_config.yaml b/docs/reference/docker_compose_config.yaml index d19a786c6..d180c8d14 100644 --- a/docs/reference/docker_compose_config.yaml +++ b/docs/reference/docker_compose_config.yaml @@ -2,8 +2,8 @@ command: docker compose config aliases: docker compose config, docker compose convert short: Parse, resolve and render compose file in canonical format long: |- - `docker compose config` renders the actual data model to be applied on the Docker engine. - it merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into + `docker compose config` renders the actual data model to be applied on the Docker Engine. + It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into the canonical format. usage: docker compose config [OPTIONS] [SERVICE...] pname: docker compose diff --git a/docs/reference/docker_compose_down.yaml b/docs/reference/docker_compose_down.yaml index 8d6388129..7964dd49c 100644 --- a/docs/reference/docker_compose_down.yaml +++ b/docs/reference/docker_compose_down.yaml @@ -5,13 +5,13 @@ long: |- By default, the only things removed are: - - Containers for services defined in the Compose file - - Networks defined in the networks section of the Compose file - - The default network, if one is used + - Containers for services defined in the Compose file. + - Networks defined in the networks section of the Compose file. + - The default network, if one is used. Networks and volumes defined as external are never removed. - Anonymous volumes are not removed by default. However, as they don’t have a stable name, they will not be automatically + Anonymous volumes are not removed by default. However, as they don’t have a stable name, they are not automatically mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or named volumes. usage: docker compose down [OPTIONS] [SERVICES] diff --git a/docs/reference/docker_compose_ps.yaml b/docs/reference/docker_compose_ps.yaml index 7525fcdb0..9e6bb072e 100644 --- a/docs/reference/docker_compose_ps.yaml +++ b/docs/reference/docker_compose_ps.yaml @@ -9,7 +9,7 @@ long: |- example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp ``` - By default, only running containers are shown. `--all` flag can be used to include stopped containers + By default, only running containers are shown. `--all` flag can be used to include stopped containers. ```console $ docker compose ps --all @@ -128,7 +128,7 @@ examples: |- ``` The JSON output allows you to use the information in other tools for further - processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/){:target="_blank" rel="noopener" class="_"} + processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/) to pretty-print the JSON: ```console diff --git a/docs/reference/docker_compose_pull.yaml b/docs/reference/docker_compose_pull.yaml index 5d2886afa..46a471162 100644 --- a/docs/reference/docker_compose_pull.yaml +++ b/docs/reference/docker_compose_pull.yaml @@ -89,7 +89,7 @@ inherited_options: kubernetes: false swarm: false examples: |- - suppose you have this `compose.yaml`: + Consider the following `compose.yaml`: ```yaml services: @@ -130,8 +130,7 @@ examples: |- ⠹ c8752d5b785c Waiting 9.3s ``` - `docker compose pull` will try to pull image for services with a build section. If pull fails, it will let - user know this service image MUST be built. You can skip this by setting `--ignore-buildable` flag + `docker compose pull` tries to pull image for services with a build section. If pull fails, it lets you know this service image must be built. You can skip this by setting `--ignore-buildable` flag. deprecated: false hidden: false experimental: false diff --git a/docs/reference/docker_compose_restart.yaml b/docs/reference/docker_compose_restart.yaml index bc907aacc..3126eb005 100644 --- a/docs/reference/docker_compose_restart.yaml +++ b/docs/reference/docker_compose_restart.yaml @@ -8,7 +8,7 @@ long: |- after a container is built, but before the container's command is executed) are not updated after restarting. - If you are looking to configure a service's restart policy, please refer to + If you are looking to configure a service's restart policy, refer to [restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart) or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy). usage: docker compose restart [OPTIONS] [SERVICE...]