Skip to content

Commit 402b5dd

Browse files
author
Misty Stanley-Jones
authored
Merge pull request #458 from docker/revert-448-PR_compose_reference_frontmatter
Revert "fix frontmatter keywords values in compose/reference/ files"
2 parents 7fdaf34 + 0827ba2 commit 402b5dd

26 files changed

+78
-52
lines changed

compose/reference/build.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: build
3-
keywords: fig, composition, compose, docker, orchestration, cli, build
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, build
45
menu:
56
main:
67
identifier: build.compose
@@ -21,4 +22,4 @@ Options:
2122

2223
Services are built once and then tagged as `project_service`, e.g.,
2324
`composetest_db`. If you change a service's Dockerfile or the contents of its
24-
build directory, run `docker-compose build` to rebuild it.
25+
build directory, run `docker-compose build` to rebuild it.

compose/reference/bundle.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Create a distributed application bundle from the Compose file.
3-
keywords: fig, composition, compose, docker, orchestration, cli, bundle
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, bundle
45
menu:
56
main:
67
identifier: bundle.compose
@@ -27,4 +28,4 @@ Images must have digests stored, which requires interaction with a
2728
Docker registry. If digests aren't stored for all images, you can fetch
2829
them with `docker-compose pull` or `docker-compose push`. To push images
2930
automatically when bundling, pass `--push-images`. Only services with
30-
a `build` option specified will have their images pushed.
31+
a `build` option specified will have their images pushed.

compose/reference/config.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Config validates and view the compose file.
3-
keywords: fig, composition, compose, docker, orchestration, cli, config
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, config
45
menu:
56
main:
67
identifier: config.compose
@@ -19,4 +20,4 @@ Options:
1920
--services Print the service names, one per line.
2021
```
2122

22-
Validate and view the compose file.
23+
Validate and view the compose file.

compose/reference/create.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Create creates containers for a service.
3-
keywords: fig, composition, compose, docker, orchestration, cli, create
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, create
45
menu:
56
main:
67
identifier: create.compose
@@ -22,4 +23,4 @@ Options:
2223
Incompatible with --force-recreate.
2324
--no-build Don't build an image, even if it's missing.
2425
--build Build images before creating containers.
25-
```
26+
```

compose/reference/down.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: down
3-
keywords: fig, composition, compose, docker, orchestration, cli, down
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, down
45
menu:
56
main:
67
identifier: down.compose
@@ -34,4 +35,4 @@ By default, the only things removed are:
3435
- Networks defined in the `networks` section of the Compose file
3536
- The default network, if one is used
3637

37-
Networks and volumes defined as `external` are never removed.
38+
Networks and volumes defined as `external` are never removed.

compose/reference/envvars.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: CLI Environment Variables
3-
keywords: fig, composition, compose, docker, orchestration, cli, reference
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, reference
45
menu:
56
main:
67
parent: smn_compose_cli
@@ -87,4 +88,4 @@ Supported values are: `TLSv1`, `TLSv1_1`, `TLSv1_2`.
8788
- [User guide](../index.md)
8889
- [Installing Compose](../install.md)
8990
- [Compose file reference](../compose-file.md)
90-
- [Environment file](../env-file.md)
91+
- [Environment file](../env-file.md)

compose/reference/events.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Receive real time events from containers.
3-
keywords: fig, composition, compose, docker, orchestration, cli, events
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, events
45
menu:
56
main:
67
identifier: events.compose
@@ -30,4 +31,4 @@ format:
3031
"image": "alpine:edge",
3132
"time": "2015-11-20T18:01:03.615550",
3233
}
33-
```
34+
```

compose/reference/exec.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: exec
3-
keywords: fig, composition, compose, docker, orchestration, cli, exec
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, exec
45
menu:
56
main:
67
identifier: exec.compose
@@ -25,4 +26,4 @@ Options:
2526

2627
This is equivalent of `docker exec`. With this subcommand you can run arbitrary
2728
commands in your services. Commands are by default allocating a TTY, so you can
28-
do e.g. `docker-compose exec web sh` to get an interactive prompt.
29+
do e.g. `docker-compose exec web sh` to get an interactive prompt.

compose/reference/help.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: help
3-
keywords: fig, composition, compose, docker, orchestration, cli, help
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, help
45
menu:
56
main:
67
identifier: help.compose
@@ -14,4 +15,4 @@ title: help
1415
Usage: help COMMAND
1516
```
1617

17-
Displays help and usage instructions for a command.
18+
Displays help and usage instructions for a command.

compose/reference/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Compose CLI reference
3-
keywords: fig, composition, compose, docker, orchestration, cli, reference
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, reference
45
menu:
56
main:
67
identifier: smn_compose_cli
@@ -38,4 +39,4 @@ The following pages describe the usage information for the [docker-compose](over
3839
## Where to go next
3940

4041
* [CLI environment variables](envvars.md)
41-
* [docker-compose Command](overview.md)
42+
* [docker-compose Command](overview.md)

compose/reference/kill.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Forces running containers to stop.
3-
keywords: fig, composition, compose, docker, orchestration, cli, kill
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, kill
45
menu:
56
main:
67
identifier: kill.compose
@@ -20,4 +21,4 @@ Options:
2021
Forces running containers to stop by sending a `SIGKILL` signal. Optionally the
2122
signal can be passed, for example:
2223

23-
$ docker-compose kill -s SIGINT
24+
$ docker-compose kill -s SIGINT

compose/reference/logs.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Displays log output from services.
3-
keywords: fig, composition, compose, docker, orchestration, cli, logs
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, logs
45
menu:
56
main:
67
identifier: logs.compose
@@ -21,4 +22,4 @@ Options:
2122
for each container.
2223
```
2324

24-
Displays log output from services.
25+
Displays log output from services.

compose/reference/overview.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
aliases:
33
- /compose/reference/docker-compose/
44
description: Overview of docker-compose CLI
5-
keywords: fig, composition, compose, docker, orchestration, cli, docker-compose
5+
keywords:
6+
- fig, composition, compose, docker, orchestration, cli, docker-compose
67
menu:
78
main:
89
parent: smn_compose_cli
@@ -123,4 +124,4 @@ envvars.md#compose-project-name)
123124

124125
## Where to go next
125126

126-
* [CLI environment variables](envvars.md)
127+
* [CLI environment variables](envvars.md)

compose/reference/pause.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Pauses running containers for a service.
3-
keywords: fig, composition, compose, docker, orchestration, cli, pause
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, pause
45
menu:
56
main:
67
identifier: pause.compose
@@ -14,4 +15,4 @@ title: pause
1415
Usage: pause [SERVICE...]
1516
```
1617

17-
Pauses running containers of a service. They can be unpaused with `docker-compose unpause`.
18+
Pauses running containers of a service. They can be unpaused with `docker-compose unpause`.

compose/reference/port.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Prints the public port for a port binding.s
3-
keywords: fig, composition, compose, docker, orchestration, cli, port
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, port
45
menu:
56
main:
67
identifier: port.compose
@@ -19,4 +20,4 @@ Options:
1920
instances of a service [default: 1]
2021
```
2122

22-
Prints the public port for a port binding.
23+
Prints the public port for a port binding.

compose/reference/ps.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Lists containers.
3-
keywords: fig, composition, compose, docker, orchestration, cli, ps
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, ps
45
menu:
56
main:
67
identifier: ps.compose
@@ -25,4 +26,4 @@ $ docker-compose ps
2526
--------------------------------------------------------------------------------------------
2627
mywordpress_db_1 docker-entrypoint.sh mysqld Up 3306/tcp
2728
mywordpress_wordpress_1 /entrypoint.sh apache2-for ... Restarting 0.0.0.0:8000->80/tcp
28-
```
29+
```

compose/reference/pull.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Pulls service images.
3-
keywords: fig, composition, compose, docker, orchestration, cli, pull
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, pull
45
menu:
56
main:
67
identifier: pull.compose
@@ -17,4 +18,4 @@ Options:
1718
--ignore-pull-failures Pull what it can and ignores images with pull failures.
1819
```
1920

20-
Pulls service images.
21+
Pulls service images.

compose/reference/push.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Pushes service images.
3-
keywords: fig, composition, compose, docker, orchestration, cli, push
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, push
45
menu:
56
main:
67
identifier: push.compose
@@ -17,4 +18,4 @@ Options:
1718
--ignore-push-failures Push what it can and ignores images with push failures.
1819
```
1920

20-
Pushes images for services.
21+
Pushes images for services.

compose/reference/restart.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Restarts Docker Compose services.
3-
keywords: fig, composition, compose, docker, orchestration, cli, restart
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, restart
45
menu:
56
main:
67
identifier: restart.compose
@@ -17,4 +18,4 @@ Options:
1718
-t, --timeout TIMEOUT Specify a shutdown timeout in seconds. (default: 10)
1819
```
1920

20-
Restarts services.
21+
Restarts services.

compose/reference/rm.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Removes stopped service containers.
3-
keywords: fig, composition, compose, docker, orchestration, cli, rm
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, rm
45
menu:
56
main:
67
identifier: rm.compose
@@ -25,4 +26,4 @@ Removes stopped service containers.
2526
By default, anonymous volumes attached to containers will not be removed. You
2627
can override this with `-v`. To list all volumes, use `docker volume ls`.
2728

28-
Any data which is not in a volume will be lost.
29+
Any data which is not in a volume will be lost.

compose/reference/run.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Runs a one-off command on a service.
3-
keywords: fig, composition, compose, docker, orchestration, cli, run
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, run
45
menu:
56
main:
67
identifier: run.compose
@@ -52,4 +53,4 @@ This would open up an interactive PostgreSQL shell for the linked `db` container
5253

5354
If you do not want the `run` command to start linked containers, specify the `--no-deps` flag:
5455

55-
$ docker-compose run --no-deps web python manage.py shell
56+
$ docker-compose run --no-deps web python manage.py shell

compose/reference/scale.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Sets the number of containers to run for a service.
3-
keywords: fig, composition, compose, docker, orchestration, cli, scale
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, scale
45
menu:
56
main:
67
parent: smn_compose_cli
@@ -17,4 +18,4 @@ Sets the number of containers to run for a service.
1718

1819
Numbers are specified as arguments in the form `service=num`. For example:
1920

20-
$ docker-compose scale web=2 worker=3
21+
$ docker-compose scale web=2 worker=3

compose/reference/start.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: Starts existing containers for a service.
3-
keywords: fig, composition, compose, docker, orchestration, cli, start
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, start
45
menu:
56
main:
67
identifier: start.compose
@@ -14,4 +15,4 @@ title: start
1415
Usage: start [SERVICE...]
1516
```
1617

17-
Starts existing containers for a service.
18+
Starts existing containers for a service.

compose/reference/stop.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: 'Stops running containers without removing them. '
3-
keywords: fig, composition, compose, docker, orchestration, cli, stop
3+
keywords:
4+
- fig, composition, compose, docker, orchestration, cli, stop
45
menu:
56
main:
67
identifier: stop.compose
@@ -18,4 +19,4 @@ Options:
1819
```
1920

2021
Stops running containers without removing them. They can be started again with
21-
`docker-compose start`.
22+
`docker-compose start`.

0 commit comments

Comments
 (0)