Skip to content

Commit 66fb94b

Browse files
author
Misty Stanley-Jones
authored
Merge pull request #448 from gdevillele/PR_compose_reference_frontmatter
fix frontmatter keywords values in compose/reference/ files
2 parents d2908c8 + bb4f3be commit 66fb94b

26 files changed

+52
-78
lines changed

compose/reference/build.md

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

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

compose/reference/bundle.md

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

compose/reference/config.md

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

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

compose/reference/create.md

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

compose/reference/down.md

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

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

compose/reference/envvars.md

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

compose/reference/events.md

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

compose/reference/exec.md

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

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

compose/reference/help.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: help
3-
keywords:
4-
- fig, composition, compose, docker, orchestration, cli, help
3+
keywords: fig, composition, compose, docker, orchestration, cli, help
54
menu:
65
main:
76
identifier: help.compose
@@ -15,4 +14,4 @@ title: help
1514
Usage: help COMMAND
1615
```
1716

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

compose/reference/index.md

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

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

compose/reference/kill.md

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

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

compose/reference/logs.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Displays log output from services.
3-
keywords:
4-
- fig, composition, compose, docker, orchestration, cli, logs
3+
keywords: fig, composition, compose, docker, orchestration, cli, logs
54
menu:
65
main:
76
identifier: logs.compose
@@ -22,4 +21,4 @@ Options:
2221
for each container.
2322
```
2423

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

compose/reference/overview.md

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

125124
## Where to go next
126125

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

compose/reference/pause.md

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

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

compose/reference/port.md

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

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

compose/reference/ps.md

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

compose/reference/pull.md

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

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

compose/reference/push.md

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

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

compose/reference/restart.md

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

21-
Restarts services.
20+
Restarts services.

compose/reference/rm.md

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

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

compose/reference/run.md

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

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

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

compose/reference/scale.md

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

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

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

compose/reference/start.md

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

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

compose/reference/stop.md

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

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

0 commit comments

Comments
 (0)