Skip to content

Commit

Permalink
fix more frontmatter keywords values (docker#439)
Browse files Browse the repository at this point in the history
* fix format of frontmatter keyword entry in some .md files

Signed-off-by: Gaetan de Villele <[email protected]>
  • Loading branch information
gdevillele authored and Misty Stanley-Jones committed Nov 4, 2016
1 parent b58945c commit 8bb4d62
Show file tree
Hide file tree
Showing 437 changed files with 932 additions and 1,509 deletions.
5 changes: 2 additions & 3 deletions compose/bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,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
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -206,4 +205,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
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -65,4 +64,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)
5 changes: 2 additions & 3 deletions compose/compose-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
aliases:
- /compose/yml
description: Compose file reference
keywords:
- fig, composition, compose, docker
keywords: fig, composition, compose, docker
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -1169,4 +1168,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
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -190,4 +189,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: Declaring default environment variables in file
keywords:
- fig, composition, compose, docker, orchestration, environment, env file
keywords: fig, composition, compose, docker, orchestration, environment, env file
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -39,4 +38,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
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -104,4 +103,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,8 +1,7 @@
---
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
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -351,4 +350,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: Getting started with Docker Compose
keywords:
- documentation, docs, docker, compose, orchestration, containers
keywords: documentation, docs, docker, compose, orchestration, containers
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -187,4 +186,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
menu:
main:
identifier: workw_compose
Expand All @@ -26,4 +25,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
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -132,4 +131,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)
5 changes: 2 additions & 3 deletions compose/link-env-deprecated.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
aliases:
- /compose/env
description: Compose CLI reference
keywords:
- fig, composition, compose, docker, orchestration, cli, reference
keywords: fig, composition, compose, docker, orchestration, cli, reference
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -46,4 +45,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
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -150,4 +149,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
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -184,4 +183,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
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -84,4 +83,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
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -171,4 +170,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/swarm.md
Original file line number Diff line number Diff line change
@@ -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
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -177,4 +176,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).
5 changes: 2 additions & 3 deletions compose/wordpress.md
Original file line number Diff line number Diff line change
@@ -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
menu:
main:
parent: workw_compose
Expand Down Expand Up @@ -113,4 +112,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)
5 changes: 2 additions & 3 deletions cs-engine/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
aliases:
- /docker-trusted-registry/cs-engine/
description: Learn more about the Commercially Supported Docker Engine.
keywords:
- docker, engine, documentation
keywords: docker, engine, documentation
menu:
main:
identifier: menu_csengine
Expand All @@ -17,4 +16,4 @@ This section includes the following topics:

* [Install CS Docker Engine](install.md)
* [Upgrade](upgrade.md)
* [Release notes](release-notes/release-notes.md)
* [Release notes](release-notes/release-notes.md)
5 changes: 2 additions & 3 deletions cs-engine/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ aliases:
- /docker-trusted-registry/install/install-csengine/
- /docker-trusted-registry/cs-engine/install/
description: Learn how to install the commercially supported version of Docker Engine.
keywords:
- docker, engine, dtr, install
keywords: docker, engine, dtr, install
menu:
main:
identifier: csengine_install
Expand Down Expand Up @@ -198,4 +197,4 @@ to the `docker` group.
$ sudo usermod -a -G docker $USER
```

8. Log out and log back in to have your new permissions take effect.
8. Log out and log back in to have your new permissions take effect.
5 changes: 2 additions & 3 deletions cs-engine/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
aliases:
- /docker-trusted-registry/cs-engine/release-notes/
description: The release notes for CS Docker Engine.
keywords:
- docker, engine, release notes
keywords: docker, engine, release notes
menu:
main:
identifier: menu_csengine_release_notes
Expand All @@ -15,4 +14,4 @@ title: Release notes
# Docker CS Engine release notes

* [Release notes](release-notes.md)
* [Prior release notes](prior-release-notes.md)
* [Prior release notes](prior-release-notes.md)
6 changes: 2 additions & 4 deletions cs-engine/release-notes/prior-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ aliases:
- /docker-trusted-registry/cse-prior-release-notes/
- /docker-trusted-registry/cs-engine/release-notes/prior-release-notes/
description: Archived release notes for commercially supported Docker Engine
keywords:
- docker, documentation, about, technology, understanding, enterprise, hub, registry,release,
commercially supported Docker Engine
keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry, release, commercially supported Docker Engine
menu:
main:
identifier: csengine_prior_release_notes
Expand Down Expand Up @@ -341,4 +339,4 @@ Because this addition is preventative, no CVE-ID is requested.
(23 Apr 2015)

First release, see the [Docker Engine 1.6.0 Release notes](/v1.6/release-notes/)
for more details.
for more details.
7 changes: 3 additions & 4 deletions cs-engine/release-notes/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@ aliases:
- /docker-trusted-registry/cse-release-notes/
- /docker-trusted-registry/cs-engine/release-notes/release-notes/
description: Commercially supported Docker Engine release notes
keywords:
- docker, documentation, about, technology, understanding, enterprise, hub, registry,
Commercially Supported Docker Engine, release notes
keywords: docker, documentation, about, technology, understanding, enterprise, hub,
registry, Commercially Supported Docker Engine, release notes
menu:
main:
identifier: csengine_release_notes
Expand Down Expand Up @@ -112,4 +111,4 @@ https://github.com/docker/docker/issues/22486
## CS Engine 1.11.1-cs1
(27 April 2016)

In this release the CS Engine is supported on RHEL 7.2 OS
In this release the CS Engine is supported on RHEL 7.2 OS
5 changes: 2 additions & 3 deletions cs-engine/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
aliases:
- /docker-trusted-registry/cs-engine/upgrade/
description: Learn how to install the commercially supported version of Docker Engine.
keywords:
- docker, engine, dtr, upgrade
keywords: docker, engine, dtr, upgrade
menu:
main:
identifier: csengine_upgrade
Expand Down Expand Up @@ -270,4 +269,4 @@ Use these instructions to update APT-based systems.
```bash
$ sudo apt-get upgrade docker-engine
```
```
5 changes: 2 additions & 3 deletions docker-cloud/apps/api-roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
aliases:
- /docker-cloud/feature-reference/api-roles/
description: API Roles
keywords:
- API, Services, roles
keywords: API, Services, roles
menu:
main:
parent: apps
Expand Down Expand Up @@ -37,4 +36,4 @@ $ curl -H "Authorization: $DOCKERCLOUD_AUTH" -H "Accept: application/json" $WEB_
For example, you can use information retrieved using the API to read the linked
endpoints, and use them to reconfigure a proxy container.

See the [API documentation](/apidocs/docker-cloud.md) for more information on the different API operations available.
See the [API documentation](/apidocs/docker-cloud.md) for more information on the different API operations available.
Loading

0 comments on commit 8bb4d62

Please sign in to comment.