Revert "fix frontmatter keywords values in compose/reference/ files"

This commit is contained in:
Misty Stanley-Jones 2016-11-04 13:28:43 -07:00 committed by GitHub
parent 7fdaf34984
commit 0827ba283c
26 changed files with 78 additions and 52 deletions

View File

@ -1,6 +1,7 @@
---
description: build
keywords: fig, composition, compose, docker, orchestration, cli, build
keywords:
- fig, composition, compose, docker, orchestration, cli, build
menu:
main:
identifier: build.compose
@ -21,4 +22,4 @@ Options:
Services are built once and then tagged as `project_service`, e.g.,
`composetest_db`. If you change a service's Dockerfile or the contents of its
build directory, run `docker-compose build` to rebuild it.
build directory, run `docker-compose build` to rebuild it.

View File

@ -1,6 +1,7 @@
---
description: Create a distributed application bundle from the Compose file.
keywords: fig, composition, compose, docker, orchestration, cli, bundle
keywords:
- fig, composition, compose, docker, orchestration, cli, bundle
menu:
main:
identifier: bundle.compose
@ -27,4 +28,4 @@ Images must have digests stored, which requires interaction with a
Docker registry. If digests aren't stored for all images, you can fetch
them with `docker-compose pull` or `docker-compose push`. To push images
automatically when bundling, pass `--push-images`. Only services with
a `build` option specified will have their images pushed.
a `build` option specified will have their images pushed.

View File

@ -1,6 +1,7 @@
---
description: Config validates and view the compose file.
keywords: fig, composition, compose, docker, orchestration, cli, config
keywords:
- fig, composition, compose, docker, orchestration, cli, config
menu:
main:
identifier: config.compose
@ -19,4 +20,4 @@ Options:
--services Print the service names, one per line.
```
Validate and view the compose file.
Validate and view the compose file.

View File

@ -1,6 +1,7 @@
---
description: Create creates containers for a service.
keywords: fig, composition, compose, docker, orchestration, cli, create
keywords:
- fig, composition, compose, docker, orchestration, cli, create
menu:
main:
identifier: create.compose
@ -22,4 +23,4 @@ Options:
Incompatible with --force-recreate.
--no-build Don't build an image, even if it's missing.
--build Build images before creating containers.
```
```

View File

@ -1,6 +1,7 @@
---
description: down
keywords: fig, composition, compose, docker, orchestration, cli, down
keywords:
- fig, composition, compose, docker, orchestration, cli, down
menu:
main:
identifier: down.compose
@ -34,4 +35,4 @@ By default, the only things removed are:
- 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.
Networks and volumes defined as `external` are never removed.

View File

@ -1,6 +1,7 @@
---
description: CLI Environment Variables
keywords: fig, composition, compose, docker, orchestration, cli, reference
keywords:
- fig, composition, compose, docker, orchestration, cli, reference
menu:
main:
parent: smn_compose_cli
@ -87,4 +88,4 @@ Supported values are: `TLSv1`, `TLSv1_1`, `TLSv1_2`.
- [User guide](../index.md)
- [Installing Compose](../install.md)
- [Compose file reference](../compose-file.md)
- [Environment file](../env-file.md)
- [Environment file](../env-file.md)

View File

@ -1,6 +1,7 @@
---
description: Receive real time events from containers.
keywords: fig, composition, compose, docker, orchestration, cli, events
keywords:
- fig, composition, compose, docker, orchestration, cli, events
menu:
main:
identifier: events.compose
@ -30,4 +31,4 @@ format:
"image": "alpine:edge",
"time": "2015-11-20T18:01:03.615550",
}
```
```

View File

@ -1,6 +1,7 @@
---
description: exec
keywords: fig, composition, compose, docker, orchestration, cli, exec
keywords:
- fig, composition, compose, docker, orchestration, cli, exec
menu:
main:
identifier: exec.compose
@ -25,4 +26,4 @@ Options:
This is equivalent of `docker exec`. With this subcommand you can run arbitrary
commands in your services. Commands are by default allocating a TTY, so you can
do e.g. `docker-compose exec web sh` to get an interactive prompt.
do e.g. `docker-compose exec web sh` to get an interactive prompt.

View File

@ -1,6 +1,7 @@
---
description: help
keywords: fig, composition, compose, docker, orchestration, cli, help
keywords:
- fig, composition, compose, docker, orchestration, cli, help
menu:
main:
identifier: help.compose
@ -14,4 +15,4 @@ title: help
Usage: help COMMAND
```
Displays help and usage instructions for a command.
Displays help and usage instructions for a command.

View File

@ -1,6 +1,7 @@
---
description: Compose CLI reference
keywords: fig, composition, compose, docker, orchestration, cli, reference
keywords:
- fig, composition, compose, docker, orchestration, cli, reference
menu:
main:
identifier: smn_compose_cli
@ -38,4 +39,4 @@ The following pages describe the usage information for the [docker-compose](over
## Where to go next
* [CLI environment variables](envvars.md)
* [docker-compose Command](overview.md)
* [docker-compose Command](overview.md)

View File

@ -1,6 +1,7 @@
---
description: Forces running containers to stop.
keywords: fig, composition, compose, docker, orchestration, cli, kill
keywords:
- fig, composition, compose, docker, orchestration, cli, kill
menu:
main:
identifier: kill.compose
@ -20,4 +21,4 @@ Options:
Forces running containers to stop by sending a `SIGKILL` signal. Optionally the
signal can be passed, for example:
$ docker-compose kill -s SIGINT
$ docker-compose kill -s SIGINT

View File

@ -1,6 +1,7 @@
---
description: Displays log output from services.
keywords: fig, composition, compose, docker, orchestration, cli, logs
keywords:
- fig, composition, compose, docker, orchestration, cli, logs
menu:
main:
identifier: logs.compose
@ -21,4 +22,4 @@ Options:
for each container.
```
Displays log output from services.
Displays log output from services.

View File

@ -2,7 +2,8 @@
aliases:
- /compose/reference/docker-compose/
description: Overview of docker-compose CLI
keywords: fig, composition, compose, docker, orchestration, cli, docker-compose
keywords:
- fig, composition, compose, docker, orchestration, cli, docker-compose
menu:
main:
parent: smn_compose_cli
@ -123,4 +124,4 @@ envvars.md#compose-project-name)
## Where to go next
* [CLI environment variables](envvars.md)
* [CLI environment variables](envvars.md)

View File

@ -1,6 +1,7 @@
---
description: Pauses running containers for a service.
keywords: fig, composition, compose, docker, orchestration, cli, pause
keywords:
- fig, composition, compose, docker, orchestration, cli, pause
menu:
main:
identifier: pause.compose
@ -14,4 +15,4 @@ title: pause
Usage: pause [SERVICE...]
```
Pauses running containers of a service. They can be unpaused with `docker-compose unpause`.
Pauses running containers of a service. They can be unpaused with `docker-compose unpause`.

View File

@ -1,6 +1,7 @@
---
description: Prints the public port for a port binding.s
keywords: fig, composition, compose, docker, orchestration, cli, port
keywords:
- fig, composition, compose, docker, orchestration, cli, port
menu:
main:
identifier: port.compose
@ -19,4 +20,4 @@ Options:
instances of a service [default: 1]
```
Prints the public port for a port binding.
Prints the public port for a port binding.

View File

@ -1,6 +1,7 @@
---
description: Lists containers.
keywords: fig, composition, compose, docker, orchestration, cli, ps
keywords:
- fig, composition, compose, docker, orchestration, cli, ps
menu:
main:
identifier: ps.compose
@ -25,4 +26,4 @@ $ docker-compose ps
--------------------------------------------------------------------------------------------
mywordpress_db_1 docker-entrypoint.sh mysqld Up 3306/tcp
mywordpress_wordpress_1 /entrypoint.sh apache2-for ... Restarting 0.0.0.0:8000->80/tcp
```
```

View File

@ -1,6 +1,7 @@
---
description: Pulls service images.
keywords: fig, composition, compose, docker, orchestration, cli, pull
keywords:
- fig, composition, compose, docker, orchestration, cli, pull
menu:
main:
identifier: pull.compose
@ -17,4 +18,4 @@ Options:
--ignore-pull-failures Pull what it can and ignores images with pull failures.
```
Pulls service images.
Pulls service images.

View File

@ -1,6 +1,7 @@
---
description: Pushes service images.
keywords: fig, composition, compose, docker, orchestration, cli, push
keywords:
- fig, composition, compose, docker, orchestration, cli, push
menu:
main:
identifier: push.compose
@ -17,4 +18,4 @@ Options:
--ignore-push-failures Push what it can and ignores images with push failures.
```
Pushes images for services.
Pushes images for services.

View File

@ -1,6 +1,7 @@
---
description: Restarts Docker Compose services.
keywords: fig, composition, compose, docker, orchestration, cli, restart
keywords:
- fig, composition, compose, docker, orchestration, cli, restart
menu:
main:
identifier: restart.compose
@ -17,4 +18,4 @@ Options:
-t, --timeout TIMEOUT Specify a shutdown timeout in seconds. (default: 10)
```
Restarts services.
Restarts services.

View File

@ -1,6 +1,7 @@
---
description: Removes stopped service containers.
keywords: fig, composition, compose, docker, orchestration, cli, rm
keywords:
- fig, composition, compose, docker, orchestration, cli, rm
menu:
main:
identifier: rm.compose
@ -25,4 +26,4 @@ Removes stopped service containers.
By default, anonymous volumes attached to containers will not be removed. You
can override this with `-v`. To list all volumes, use `docker volume ls`.
Any data which is not in a volume will be lost.
Any data which is not in a volume will be lost.

View File

@ -1,6 +1,7 @@
---
description: Runs a one-off command on a service.
keywords: fig, composition, compose, docker, orchestration, cli, run
keywords:
- fig, composition, compose, docker, orchestration, cli, run
menu:
main:
identifier: run.compose
@ -52,4 +53,4 @@ This would open up an interactive PostgreSQL shell for the linked `db` container
If you do not want the `run` command to start linked containers, specify the `--no-deps` flag:
$ docker-compose run --no-deps web python manage.py shell
$ docker-compose run --no-deps web python manage.py shell

View File

@ -1,6 +1,7 @@
---
description: Sets the number of containers to run for a service.
keywords: fig, composition, compose, docker, orchestration, cli, scale
keywords:
- fig, composition, compose, docker, orchestration, cli, scale
menu:
main:
parent: smn_compose_cli
@ -17,4 +18,4 @@ Sets the number of containers to run for a service.
Numbers are specified as arguments in the form `service=num`. For example:
$ docker-compose scale web=2 worker=3
$ docker-compose scale web=2 worker=3

View File

@ -1,6 +1,7 @@
---
description: Starts existing containers for a service.
keywords: fig, composition, compose, docker, orchestration, cli, start
keywords:
- fig, composition, compose, docker, orchestration, cli, start
menu:
main:
identifier: start.compose
@ -14,4 +15,4 @@ title: start
Usage: start [SERVICE...]
```
Starts existing containers for a service.
Starts existing containers for a service.

View File

@ -1,6 +1,7 @@
---
description: 'Stops running containers without removing them. '
keywords: fig, composition, compose, docker, orchestration, cli, stop
keywords:
- fig, composition, compose, docker, orchestration, cli, stop
menu:
main:
identifier: stop.compose
@ -18,4 +19,4 @@ Options:
```
Stops running containers without removing them. They can be started again with
`docker-compose start`.
`docker-compose start`.

View File

@ -1,6 +1,7 @@
---
description: Unpauses paused containers for a service.
keywords: fig, composition, compose, docker, orchestration, cli, unpause
keywords:
- fig, composition, compose, docker, orchestration, cli, unpause
menu:
main:
identifier: unpause.compose
@ -14,4 +15,4 @@ title: unpause
Usage: unpause [SERVICE...]
```
Unpauses paused containers of a service.
Unpauses paused containers of a service.

View File

@ -1,6 +1,7 @@
---
description: Builds, (re)creates, starts, and attaches to containers for a service.
keywords: fig, composition, compose, docker, orchestration, cli, up
keywords:
- fig, composition, compose, docker, orchestration, cli, up
menu:
main:
identifier: up.compose
@ -51,4 +52,4 @@ volumes). To prevent Compose from picking up changes, use the `--no-recreate`
flag.
If you want to force Compose to stop and recreate all containers, use the
`--force-recreate` flag.
`--force-recreate` flag.