Skip to content

Commit

Permalink
fix type of keywords entry in frontmatter (in /compose/ dir) (docker#481
Browse files Browse the repository at this point in the history
)

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

Signed-off-by: Gaetan de Villele <[email protected]>
  • Loading branch information
gdevillele authored and johndmulhausen committed Nov 7, 2016
1 parent 71ff5c1 commit 2ea5641
Show file tree
Hide file tree
Showing 43 changed files with 89 additions and 132 deletions.
5 changes: 2 additions & 3 deletions compose/bundles.md
Original file line number Diff line number Diff line change
@@ -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)
---

Expand Down Expand Up @@ -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.
5 changes: 2 additions & 3 deletions compose/completion.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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)
7 changes: 3 additions & 4 deletions compose/compose-file.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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)
5 changes: 2 additions & 3 deletions compose/django.md
Original file line number Diff line number Diff line change
@@ -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"
---

Expand Down Expand Up @@ -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)
5 changes: 2 additions & 3 deletions compose/env-file.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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)
5 changes: 2 additions & 3 deletions compose/environment-variables.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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.
5 changes: 2 additions & 3 deletions compose/extends.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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)
5 changes: 2 additions & 3 deletions compose/gettingstarted.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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)
5 changes: 2 additions & 3 deletions compose/index.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -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).
5 changes: 2 additions & 3 deletions compose/install.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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)
7 changes: 3 additions & 4 deletions compose/link-env-deprecated.md
Original file line number Diff line number Diff line change
@@ -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)
---

Expand Down Expand Up @@ -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)
5 changes: 2 additions & 3 deletions compose/networking.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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.
5 changes: 2 additions & 3 deletions compose/overview.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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/).
5 changes: 2 additions & 3 deletions compose/production.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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)
5 changes: 2 additions & 3 deletions compose/rails.md
Original file line number Diff line number Diff line change
@@ -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"
---

Expand Down Expand Up @@ -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)
5 changes: 2 additions & 3 deletions compose/reference/build.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -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.
5 changes: 2 additions & 3 deletions compose/reference/bundle.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -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.
5 changes: 2 additions & 3 deletions compose/reference/config.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -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.
5 changes: 2 additions & 3 deletions compose/reference/create.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -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.
```
```
5 changes: 2 additions & 3 deletions compose/reference/down.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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.
5 changes: 2 additions & 3 deletions compose/reference/envvars.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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)
5 changes: 2 additions & 3 deletions compose/reference/events.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -25,4 +24,4 @@ format:
"image": "alpine:edge",
"time": "2015-11-20T18:01:03.615550",
}
```
```
5 changes: 2 additions & 3 deletions compose/reference/exec.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -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.
5 changes: 2 additions & 3 deletions compose/reference/help.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
description: docker-compose help
keywords:
- fig, composition, compose, docker, orchestration, cli, help
keywords: fig, composition, compose, docker, orchestration, cli, help
title: docker-compose help
---

```
Usage: help COMMAND
```

Displays help and usage instructions for a command.
Displays help and usage instructions for a command.
Loading

0 comments on commit 2ea5641

Please sign in to comment.