Skip to content

Commit 9631a49

Browse files
aevesdockeraevesdocker
committed
ENGDOCS-1764
Signed-off-by: aevesdocker <[email protected]>
1 parent 328ca3f commit 9631a49

30 files changed

+89
-90
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_publish.md

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

33
<!---MARKER_GEN_START-->
4-
Publish compose application
4+
Publish a Compose application.
55

66
### Options
77

‎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_alpha_viz.md

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

33
<!---MARKER_GEN_START-->
4-
EXPERIMENTAL - Generate a graphviz graph from your compose file
4+
Generate a Graphviz graph from your compose file
55

66
### Options
77

@@ -12,7 +12,7 @@ EXPERIMENTAL - Generate a graphviz graph from your compose file
1212
| `--indentation-size` | `int` | `1` | Number of tabs or spaces to use for indentation |
1313
| `--networks` | | | Include service's attached networks in output graph |
1414
| `--ports` | | | Include service's exposed ports in output graph |
15-
| `--spaces` | | | If given, space character ' ' will be used to indent,<br>otherwise tab character '\t' will be used |
15+
| `--spaces` | | | If given, space character ' ' is used to indent,<br>otherwise tab character '\t' is used |
1616

1717

1818
<!---MARKER_GEN_END-->

‎docs/reference/compose_build.md

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

33
<!---MARKER_GEN_START-->
4-
Build or rebuild services
4+
Build or rebuild services.
55

66
### Options
77

‎docs/reference/compose_config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# docker compose convert
22

33
<!---MARKER_GEN_START-->
4-
Parse, resolve and render compose file in canonical format
4+
Parse, resolve and render Compose files in canonical format.
55

66
### Aliases
77

@@ -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_cp.md

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

33
<!---MARKER_GEN_START-->
4-
Copy files/folders between a service container and the local filesystem
4+
Copy files or folders between a service container and the local filesystem.
55

66
### Options
77

‎docs/reference/compose_create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Creates containers for a service.
1010
| `--build` | | | Build images before starting containers. |
1111
| `--dry-run` | | | Execute command in dry run mode |
1212
| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. |
13-
| `--no-build` | | | Don't build an image, even if it's policy. |
13+
| `--no-build` | | | Don't build an image, even if it's policy |
1414
| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. |
1515
| `--pull` | `string` | `policy` | Pull image before running ("always"\|"policy"\|"never") |
16-
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
16+
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file |
1717
| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. |
1818

1919

‎docs/reference/compose_down.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# docker compose down
22

33
<!---MARKER_GEN_START-->
4-
Stop and remove containers, networks
4+
Stop and remove containers, networks, volumes, and images.
55

66
### Options
77

88
| Name | Type | Default | Description |
99
|:-------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------|
1010
| `--dry-run` | | | Execute command in dry run mode |
11-
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
11+
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file |
1212
| `--rmi` | `string` | | Remove images used by services. "local" remove only images that don't have a custom tag ("local"\|"all") |
1313
| `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds |
14-
| `-v`, `--volumes` | | | Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers. |
14+
| `-v`, `--volumes` | | | Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers.] |
1515

1616

1717
<!---MARKER_GEN_END-->
@@ -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.

0 commit comments

Comments
 (0)