Skip to content

Commit 5661fd1

Browse files
authored
Merge pull request docker#11149 from aevesdocker/ENGDOCS-1764
ENGDOCS-1764: Trivial fixes
2 parents 328ca3f + 4cd6195 commit 5661fd1

14 files changed

+35
-37
lines changed

docs/reference/compose.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Define and run multi-container applications with Docker.
5757

5858
## Description
5959

60-
You can use compose subcommand, `docker compose [-f <arg>...] [options] [COMMAND] [ARGS...]`, to build and manage
60+
You can use the compose subcommand, `docker compose [-f <arg>...] [options] [COMMAND] [ARGS...]`, to build and manage
6161
multiple services in Docker containers.
6262

6363
### 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
146146
### Use profiles to enable optional services
147147

148148
Use `--profile` to specify one or more active profiles
149-
Calling `docker compose --profile frontend up` will start the services with the profile `frontend` and services
149+
Calling `docker compose --profile frontend up` starts the services with the profile `frontend` and services
150150
without any specified profiles.
151-
You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` will be enabled.
151+
You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` is enabled.
152152

153153
Profiles can also be set by `COMPOSE_PROFILES` environment variable.
154154

155155
### Configuring parallelism
156156

157157
Use `--parallel` to specify the maximum level of parallelism for concurrent engine calls.
158-
Calling `docker compose --parallel 1 pull` will pull the pullable images defined in the Compose file
158+
Calling `docker compose --parallel 1 pull` pulls the pullable images defined in the Compose file
159159
one at a time. This can also be used to control build concurrency.
160160

161161
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.
171171

172172
If flags are explicitly set on the command line, the associated environment variable is ignored.
173173

174-
Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned
174+
Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` stops docker compose from detecting orphaned
175175
containers for the project.
176176

177177
### Use Dry Run mode to test your command

docs/reference/compose_alpha_dry-run.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# docker compose alpha dry-run
22

33
<!---MARKER_GEN_START-->
4-
EXPERIMENTAL - Dry run command allow you to test a command without applying changes
4+
Dry run command allows you to test a command without applying changes.
55

66

77
<!---MARKER_GEN_END-->

docs/reference/compose_alpha_scale.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# docker compose alpha scale
22

33
<!---MARKER_GEN_START-->
4-
Scale services
4+
Scale services.
55

66
### Options
77

88
| Name | Type | Default | Description |
99
|:------------|:-----|:--------|:--------------------------------|
1010
| `--dry-run` | | | Execute command in dry run mode |
11-
| `--no-deps` | | | Don't start linked services. |
11+
| `--no-deps` | | | Don't start linked services |
1212

1313

1414
<!---MARKER_GEN_END-->

docs/reference/compose_config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@ Parse, resolve and render compose file in canonical format
3131

3232
## Description
3333

34-
`docker compose config` renders the actual data model to be applied on the Docker engine.
35-
it merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
34+
`docker compose config` renders the actual data model to be applied on the Docker Engine.
35+
It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
3636
the canonical format.

docs/reference/compose_down.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ Stops containers and removes containers, networks, volumes, and images created b
2222

2323
By default, the only things removed are:
2424

25-
- Containers for services defined in the Compose file
26-
- Networks defined in the networks section of the Compose file
27-
- The default network, if one is used
25+
- Containers for services defined in the Compose file.
26+
- Networks defined in the networks section of the Compose file.
27+
- The default network, if one is used.
2828

2929
Networks and volumes defined as external are never removed.
3030

31-
Anonymous volumes are not removed by default. However, as they don’t have a stable name, they will not be automatically
31+
Anonymous volumes are not removed by default. However, as they don’t have a stable name, they are not automatically
3232
mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or
3333
named volumes.

docs/reference/compose_ps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ NAME IMAGE COMMAND SERVICE CREATED STATUS
2929
example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp
3030
```
3131

32-
By default, only running containers are shown. `--all` flag can be used to include stopped containers
32+
By default, only running containers are shown. `--all` flag can be used to include stopped containers.
3333

3434
```console
3535
$ docker compose ps --all
@@ -53,7 +53,7 @@ $ docker compose ps --format json
5353
```
5454

5555
The JSON output allows you to use the information in other tools for further
56-
processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/){:target="_blank" rel="noopener" class="_"}
56+
processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/)
5757
to pretty-print the JSON:
5858

5959
```console

docs/reference/compose_pull.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ those images.
2525

2626
## Examples
2727

28-
suppose you have this `compose.yaml`:
28+
Consider the following `compose.yaml`:
2929

3030
```yaml
3131
services:
@@ -66,5 +66,4 @@ $ docker compose pull db
6666
⠹ c8752d5b785c Waiting 9.3s
6767
```
6868

69-
`docker compose pull` will try to pull image for services with a build section. If pull fails, it will let
70-
user know this service image MUST be built. You can skip this by setting `--ignore-buildable` flag
69+
`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.

docs/reference/compose_restart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ after running this command. For example, changes to environment variables (which
2323
after a container is built, but before the container's command is executed) are not updated
2424
after restarting.
2525

26-
If you are looking to configure a service's restart policy, please refer to
26+
If you are looking to configure a service's restart policy, refer to
2727
[restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart)
2828
or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy).

docs/reference/docker_compose.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
command: docker compose
22
short: Docker Compose
33
long: |-
4-
You can use compose subcommand, `docker compose [-f <arg>...] [options] [COMMAND] [ARGS...]`, to build and manage
4+
You can use the compose subcommand, `docker compose [-f <arg>...] [options] [COMMAND] [ARGS...]`, to build and manage
55
multiple services in Docker containers.
66
77
### Use `-f` to specify the name and path of one or more Compose files
@@ -90,16 +90,16 @@ long: |-
9090
### Use profiles to enable optional services
9191
9292
Use `--profile` to specify one or more active profiles
93-
Calling `docker compose --profile frontend up` will start the services with the profile `frontend` and services
93+
Calling `docker compose --profile frontend up` starts the services with the profile `frontend` and services
9494
without any specified profiles.
95-
You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` will be enabled.
95+
You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` is enabled.
9696
9797
Profiles can also be set by `COMPOSE_PROFILES` environment variable.
9898
9999
### Configuring parallelism
100100
101101
Use `--parallel` to specify the maximum level of parallelism for concurrent engine calls.
102-
Calling `docker compose --parallel 1 pull` will pull the pullable images defined in the Compose file
102+
Calling `docker compose --parallel 1 pull` pulls the pullable images defined in the Compose file
103103
one at a time. This can also be used to control build concurrency.
104104
105105
Parallelism can also be set by the `COMPOSE_PARALLEL_LIMIT` environment variable.
@@ -115,7 +115,7 @@ long: |-
115115
116116
If flags are explicitly set on the command line, the associated environment variable is ignored.
117117
118-
Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned
118+
Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` stops docker compose from detecting orphaned
119119
containers for the project.
120120
121121
### Use Dry Run mode to test your command

docs/reference/docker_compose_config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ command: docker compose config
22
aliases: docker compose config, docker compose convert
33
short: Parse, resolve and render compose file in canonical format
44
long: |-
5-
`docker compose config` renders the actual data model to be applied on the Docker engine.
6-
it merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
5+
`docker compose config` renders the actual data model to be applied on the Docker Engine.
6+
It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
77
the canonical format.
88
usage: docker compose config [OPTIONS] [SERVICE...]
99
pname: docker compose

0 commit comments

Comments
 (0)