fix type of keywords entry in frontmatter (in /compose/ dir) (#481)

keywords should be a string, not an array containing one string

Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
This commit is contained in:
Gaetan 2016-11-07 13:18:56 -08:00 committed by John Mulhausen
parent 71ff5c1589
commit 2ea564166d
43 changed files with 89 additions and 132 deletions

View File

@ -1,8 +1,7 @@
---
advisory: experimental
description: Description of Docker and Compose's experimental support for application bundles
keywords:
- documentation, docs, docker, compose, bundles, stacks
keywords: documentation, docs, docker, compose, bundles, stacks
title: Docker stacks and distributed application bundles (experimental)
---
@ -200,4 +199,4 @@ A service has the following fields:
</dl>
> **Note:** Some configuration options are not yet supported in the DAB format,
> including volume mounts.
> including volume mounts.

View File

@ -1,7 +1,6 @@
---
description: Compose CLI reference
keywords:
- fig, composition, compose, docker, orchestration, cli, reference
keywords: fig, composition, compose, docker, orchestration, cli, reference
title: Command-line completion
---
@ -59,4 +58,4 @@ Enjoy working with Compose faster and with less typos!
- [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md)
- [Command line reference](./reference/index.md)
- [Compose file reference](compose-file.md)
- [Compose file reference](compose-file.md)

View File

@ -1,9 +1,8 @@
---
description: Compose file reference
keywords: fig, composition, compose, docker
redirect_from:
- /compose/yml
description: Compose file reference
keywords:
- fig, composition, compose, docker
title: Compose file reference
---
@ -1163,4 +1162,4 @@ If you forget and use a single dollar sign (`$`), Compose interprets the value a
- [Get started with Django](django.md)
- [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md)
- [Command line reference](./reference/index.md)
- [Command line reference](./reference/index.md)

View File

@ -1,7 +1,6 @@
---
description: Getting started with Docker Compose and Django
keywords:
- documentation, docs, docker, compose, orchestration, containers
keywords: documentation, docs, docker, compose, orchestration, containers
title: "Quickstart: Compose and Django"
---
@ -184,4 +183,4 @@ In this section, you set up the database connection for Django.
- [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md)
- [Command line reference](./reference/index.md)
- [Compose file reference](compose-file.md)
- [Compose file reference](compose-file.md)

View File

@ -1,7 +1,6 @@
---
description: Declare default environment variables in a file
keywords:
- fig, composition, compose, docker, orchestration, environment, env file
keywords: fig, composition, compose, docker, orchestration, environment, env file
title: Declare default environment variables in file
---
@ -33,4 +32,4 @@ file, but can also be used to define the following
- [User guide](index.md)
- [Command line reference](./reference/index.md)
- [Compose file reference](compose-file.md)
- [Compose file reference](compose-file.md)

View File

@ -1,7 +1,6 @@
---
description: How to set, use and manage environment variables in Compose
keywords:
- fig, composition, compose, docker, orchestration, environment, variables, env file
keywords: fig, composition, compose, docker, orchestration, environment, variables, env file
title: Environment variables in Compose
---
@ -98,4 +97,4 @@ Several environment variables are available for you to configure the Docker Comp
## Environment variables created by links
When using the ['links' option](compose-file.md#links) in a [v1 Compose file](compose-file.md#version-1), environment variables will be created for each link. They are documented in the [Link environment variables reference](link-env-deprecated.md). Please note, however, that these variables are deprecated - you should just use the link alias as a hostname instead.
When using the ['links' option](compose-file.md#links) in a [v1 Compose file](compose-file.md#version-1), environment variables will be created for each link. They are documented in the [Link environment variables reference](link-env-deprecated.md). Please note, however, that these variables are deprecated - you should just use the link alias as a hostname instead.

View File

@ -1,7 +1,6 @@
---
description: How to use Docker Compose's extends keyword to share configuration between files and projects
keywords:
- fig, composition, compose, docker, orchestration, documentation, docs
keywords: fig, composition, compose, docker, orchestration, documentation, docs
title: Share Compose configurations between files and projects
---
@ -344,4 +343,4 @@ In the case of `environment`, `labels`, `volumes` and `devices`, Compose
- [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md)
- [Command line reference](./reference/index.md)
- [Compose file reference](compose-file.md)
- [Compose file reference](compose-file.md)

View File

@ -1,7 +1,6 @@
---
description: Get started with Docker Compose
keywords:
- documentation, docs, docker, compose, orchestration, containers
keywords: documentation, docs, docker, compose, orchestration, containers
title: Get started with Docker Compose
---
@ -181,4 +180,4 @@ At this point, you have seen the basics of how Compose works.
- Next, try the quick start guide for [Django](django.md),
[Rails](rails.md), or [WordPress](wordpress.md).
- [Explore the full list of Compose commands](./reference/index.md)
- [Compose configuration file reference](compose-file.md)
- [Compose configuration file reference](compose-file.md)

View File

@ -1,7 +1,6 @@
---
description: Introduction and Overview of Compose
keywords:
- documentation, docs, docker, compose, orchestration, containers
keywords: documentation, docs, docker, compose, orchestration, containers
title: Docker Compose
---
@ -20,4 +19,4 @@ Compose is a tool for defining and running multi-container Docker applications.
To see a detailed list of changes for past and current releases of Docker
Compose, please refer to the
[CHANGELOG](https://github.com/docker/compose/blob/master/CHANGELOG.md).
[CHANGELOG](https://github.com/docker/compose/blob/master/CHANGELOG.md).

View File

@ -1,7 +1,6 @@
---
description: How to install Docker Compose
keywords:
- compose, orchestration, install, installation, docker, documentation
keywords: compose, orchestration, install, installation, docker, documentation
title: Install Docker Compose
---
@ -126,4 +125,4 @@ To uninstall Docker Compose if you installed using `pip`:
- [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md)
- [Command line reference](./reference/index.md)
- [Compose file reference](compose-file.md)
- [Compose file reference](compose-file.md)

View File

@ -1,9 +1,8 @@
---
description: Compose CLI reference
keywords: fig, composition, compose, docker, orchestration, cli, reference
redirect_from:
- /compose/env
description: Compose CLI reference
keywords:
- fig, composition, compose, docker, orchestration, cli, reference
title: Link environment variables (superseded)
---
@ -40,4 +39,4 @@ Fully qualified container name, e.g. `DB_1_NAME=/myapp_web_1/myapp_db_1`
- [User guide](index.md)
- [Installing Compose](install.md)
- [Command line reference](./reference/index.md)
- [Compose file reference](compose-file.md)
- [Compose file reference](compose-file.md)

View File

@ -1,7 +1,6 @@
---
description: How Compose sets up networking between containers
keywords:
- documentation, docs, docker, compose, orchestration, containers, networking
keywords: documentation, docs, docker, compose, orchestration, containers, networking
title: Networking in Compose
---
@ -144,4 +143,4 @@ If you want your containers to join a pre-existing network, use the [`external`
external:
name: my-pre-existing-network
Instead of attempting to create a network called `[projectname]_default`, Compose will look for a network called `my-pre-existing-network` and connect your app's containers to it.
Instead of attempting to create a network called `[projectname]_default`, Compose will look for a network called `my-pre-existing-network` and connect your app's containers to it.

View File

@ -1,7 +1,6 @@
---
description: Introduction and Overview of Compose
keywords:
- documentation, docs, docker, compose, orchestration, containers
keywords: documentation, docs, docker, compose, orchestration, containers
title: Overview of Docker Compose
---
@ -178,4 +177,4 @@ individuals, we have a number of open channels for communication.
* To contribute code or documentation changes: please submit a [pull request on Github](https://github.com/docker/compose/pulls).
For more information and resources, please visit the [Getting Help project page](/opensource/get-help/).
For more information and resources, please visit the [Getting Help project page](/opensource/get-help/).

View File

@ -1,7 +1,6 @@
---
description: Guide to using Docker Compose in production
keywords:
- documentation, docs, docker, compose, orchestration, containers, production
keywords: documentation, docs, docker, compose, orchestration, containers, production
title: Using Compose in production
---
@ -78,4 +77,4 @@ Read more about the Compose/Swarm integration in the
- [Installing Compose](install.md)
- [Command line reference](./reference/index.md)
- [Compose file reference](compose-file.md)
- [Compose file reference](compose-file.md)

View File

@ -1,7 +1,6 @@
---
description: Getting started with Docker Compose and Rails
keywords:
- documentation, docs, docker, compose, orchestration, containers
keywords: documentation, docs, docker, compose, orchestration, containers
title: "Quickstart: Compose and Rails"
---
@ -165,4 +164,4 @@ up`.
- [Get started with Django](django.md)
- [Get started with WordPress](wordpress.md)
- [Command line reference](./reference/index.md)
- [Compose file reference](compose-file.md)
- [Compose file reference](compose-file.md)

View File

@ -1,7 +1,6 @@
---
description: docker-compose build
keywords:
- fig, composition, compose, docker, orchestration, cli, build
keywords: fig, composition, compose, docker, orchestration, cli, build
title: docker-compose build
---
@ -16,4 +15,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,7 +1,6 @@
---
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
title: docker-compose bundle
---
@ -22,4 +21,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,7 +1,6 @@
---
description: Config validates and view the compose file.
keywords:
- fig, composition, compose, docker, orchestration, cli, config
keywords: fig, composition, compose, docker, orchestration, cli, config
title: docker-compose config
---
@ -14,4 +13,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,7 +1,6 @@
---
description: Create creates containers for a service.
keywords:
- fig, composition, compose, docker, orchestration, cli, create
keywords: fig, composition, compose, docker, orchestration, cli, create
title: docker-compose create
---
@ -17,4 +16,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,7 +1,6 @@
---
description: docker-compose down
keywords:
- fig, composition, compose, docker, orchestration, cli, down
keywords: fig, composition, compose, docker, orchestration, cli, down
title: docker-compose down
---
@ -29,4 +28,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,7 +1,6 @@
---
description: Compose CLI environment variables
keywords:
- fig, composition, compose, docker, orchestration, cli, reference
keywords: fig, composition, compose, docker, orchestration, cli, reference
title: Compose CLI environment variables
---
@ -82,4 +81,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,7 +1,6 @@
---
description: Receive real time events from containers.
keywords:
- fig, composition, compose, docker, orchestration, cli, events
keywords: fig, composition, compose, docker, orchestration, cli, events
title: docker-compose events
---
@ -25,4 +24,4 @@ format:
"image": "alpine:edge",
"time": "2015-11-20T18:01:03.615550",
}
```
```

View File

@ -1,7 +1,6 @@
---
description: docker-compose exec
keywords:
- fig, composition, compose, docker, orchestration, cli, exec
keywords: fig, composition, compose, docker, orchestration, cli, exec
title: docker-compose exec
---
@ -20,4 +19,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,7 +1,6 @@
---
description: docker-compose help
keywords:
- fig, composition, compose, docker, orchestration, cli, help
keywords: fig, composition, compose, docker, orchestration, cli, help
title: docker-compose help
---
@ -9,4 +8,4 @@ title: docker-compose help
Usage: help COMMAND
```
Displays help and usage instructions for a command.
Displays help and usage instructions for a command.

View File

@ -1,7 +1,6 @@
---
description: Compose CLI reference
keywords:
- fig, composition, compose, docker, orchestration, cli, reference
keywords: fig, composition, compose, docker, orchestration, cli, reference
title: Compose command-line reference
---
@ -32,4 +31,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,7 +1,6 @@
---
description: Forces running containers to stop.
keywords:
- fig, composition, compose, docker, orchestration, cli, kill
keywords: fig, composition, compose, docker, orchestration, cli, kill
title: docker-compose kill
---
@ -15,4 +14,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,7 +1,6 @@
---
description: Displays log output from services.
keywords:
- fig, composition, compose, docker, orchestration, cli, logs
keywords: fig, composition, compose, docker, orchestration, cli, logs
title: docker-compose logs
---
@ -16,4 +15,4 @@ Options:
for each container.
```
Displays log output from services.
Displays log output from services.

View File

@ -1,9 +1,8 @@
---
description: Overview of docker-compose CLI
keywords: fig, composition, compose, docker, orchestration, cli, docker-compose
redirect_from:
- /compose/reference/docker-compose/
description: Overview of docker-compose CLI
keywords:
- fig, composition, compose, docker, orchestration, cli, docker-compose
title: Overview of docker-compose CLI
---
@ -118,4 +117,4 @@ envvars.md#compose-project-name)
## Where to go next
* [CLI environment variables](envvars.md)
* [CLI environment variables](envvars.md)

View File

@ -1,7 +1,6 @@
---
description: Pauses running containers for a service.
keywords:
- fig, composition, compose, docker, orchestration, cli, pause
keywords: fig, composition, compose, docker, orchestration, cli, pause
title: docker-compose pause
---
@ -9,4 +8,4 @@ title: docker-compose 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,7 +1,6 @@
---
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
title: docker-compose port
---
@ -14,4 +13,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,7 +1,6 @@
---
description: Lists containers.
keywords:
- fig, composition, compose, docker, orchestration, cli, ps
keywords: fig, composition, compose, docker, orchestration, cli, ps
title: docker-compose ps
---
@ -20,4 +19,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,7 +1,6 @@
---
description: Pulls service images.
keywords:
- fig, composition, compose, docker, orchestration, cli, pull
keywords: fig, composition, compose, docker, orchestration, cli, pull
title: docker-compose pull
---
@ -12,4 +11,4 @@ Options:
--ignore-pull-failures Pull what it can and ignores images with pull failures.
```
Pulls service images.
Pulls service images.

View File

@ -1,7 +1,6 @@
---
description: Pushes service images.
keywords:
- fig, composition, compose, docker, orchestration, cli, push
keywords: fig, composition, compose, docker, orchestration, cli, push
title: docker-compose push
---
@ -12,4 +11,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,7 +1,6 @@
---
description: Restarts Docker Compose services.
keywords:
- fig, composition, compose, docker, orchestration, cli, restart
keywords: fig, composition, compose, docker, orchestration, cli, restart
title: docker-compose restart
---
@ -12,4 +11,4 @@ Options:
-t, --timeout TIMEOUT Specify a shutdown timeout in seconds. (default: 10)
```
Restarts services.
Restarts services.

View File

@ -1,7 +1,6 @@
---
description: Removes stopped service containers.
keywords:
- fig, composition, compose, docker, orchestration, cli, rm
keywords: fig, composition, compose, docker, orchestration, cli, rm
title: docker-compose rm
---
@ -20,4 +19,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,7 +1,6 @@
---
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
title: docker-compose run
---
@ -47,4 +46,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,7 +1,6 @@
---
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
title: docker-compose scale
---
@ -13,4 +12,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,7 +1,6 @@
---
description: Starts existing containers for a service.
keywords:
- fig, composition, compose, docker, orchestration, cli, start
keywords: fig, composition, compose, docker, orchestration, cli, start
title: docker-compose start
---
@ -9,4 +8,4 @@ title: docker-compose start
Usage: start [SERVICE...]
```
Starts existing containers for a service.
Starts existing containers for a service.

View File

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

View File

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

View File

@ -1,7 +1,6 @@
---
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
title: docker-compose up
---
@ -46,4 +45,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.

View File

@ -1,7 +1,6 @@
---
description: How to use Compose and Swarm together to deploy apps to multi-host clusters
keywords:
- documentation, docs, docker, compose, orchestration, containers, swarm
keywords: documentation, docs, docker, compose, orchestration, containers, swarm
title: Use Compose with Swarm
---
@ -172,4 +171,4 @@ them.
- "affinity:image==redis"
For the full set of available filters and expressions, see the [Swarm
documentation](/swarm/scheduler/filter.md).
documentation](/swarm/scheduler/filter.md).

View File

@ -1,7 +1,6 @@
---
description: Getting started with Compose and WordPress
keywords:
- documentation, docs, docker, compose, orchestration, containers
keywords: documentation, docs, docker, compose, orchestration, containers
title: "Quickstart: Compose and WordPress"
---
@ -107,4 +106,4 @@ At this point, WordPress should be running on port `8000` of your Docker Host, a
- [Get started with Django](django.md)
- [Get started with Rails](rails.md)
- [Command line reference](./reference/index.md)
- [Compose file reference](compose-file.md)
- [Compose file reference](compose-file.md)