removed on-page topic menu from ref pages

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
This commit is contained in:
Victoria Bialas
2017-02-17 18:02:58 -08:00
parent 15dc27ff75
commit 4a70dd4cb2
30 changed files with 54 additions and 23 deletions

View File

@@ -2,6 +2,7 @@
description: Declare default environment variables in a file
keywords: fig, composition, compose, docker, orchestration, environment, env file
title: Declare default environment variables in file
notoc: true
---
Compose supports declaring default environment variables in an environment
@@ -34,4 +35,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

@@ -4,6 +4,7 @@ keywords: fig, composition, compose, docker, orchestration, cli, reference
redirect_from:
- /compose/env
title: Link environment variables (superseded)
notoc: true
---
> **Note:** Environment variables are no longer the recommended method for connecting to linked services. Instead, you should use the link name (by default, the name of the linked service) as the hostname to connect to. See the [docker-compose.yml documentation](compose-file.md#links) for details.
@@ -39,4 +40,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

@@ -2,6 +2,8 @@
description: docker-compose build
keywords: fig, composition, compose, docker, orchestration, cli, build
title: docker-compose build
notoc: true
---
```
@@ -15,4 +17,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

@@ -2,6 +2,7 @@
description: Create a distributed application bundle from the Compose file.
keywords: fig, composition, compose, docker, orchestration, cli, bundle
title: docker-compose bundle
notoc: true
---
```
@@ -21,4 +22,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

@@ -2,6 +2,7 @@
description: Config validates and view the compose file.
keywords: fig, composition, compose, docker, orchestration, cli, config
title: docker-compose config
notoc: true
---
```:
@@ -13,4 +14,4 @@ Options:
--services Print the service names, one per line.
```
Validate and view the compose file.
Validate and view the compose file.

View File

@@ -2,6 +2,7 @@
description: Create creates containers for a service.
keywords: fig, composition, compose, docker, orchestration, cli, create
title: docker-compose create
notoc: true
---
```
@@ -16,4 +17,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

@@ -2,6 +2,7 @@
description: docker-compose down
keywords: fig, composition, compose, docker, orchestration, cli, down
title: docker-compose down
notoc: true
---
```
@@ -28,4 +29,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

@@ -2,6 +2,7 @@
description: Compose CLI environment variables
keywords: fig, composition, compose, docker, orchestration, cli, reference
title: Compose CLI environment variables
notoc: true
---
Several environment variables are available for you to configure the Docker Compose command-line behaviour.

View File

@@ -2,6 +2,7 @@
description: Receive real time events from containers.
keywords: fig, composition, compose, docker, orchestration, cli, events
title: docker-compose events
notoc: true
---
```
@@ -24,4 +25,4 @@ format:
"image": "alpine:edge",
"time": "2015-11-20T18:01:03.615550",
}
```
```

View File

@@ -2,6 +2,7 @@
description: docker-compose exec
keywords: fig, composition, compose, docker, orchestration, cli, exec
title: docker-compose exec
notoc: true
---
```
@@ -19,4 +20,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

@@ -2,10 +2,11 @@
description: docker-compose help
keywords: fig, composition, compose, docker, orchestration, cli, help
title: docker-compose help
notoc: true
---
```
Usage: help COMMAND
```
Displays help and usage instructions for a command.
Displays help and usage instructions for a command.

View File

@@ -2,6 +2,7 @@
description: Compose CLI reference
keywords: fig, composition, compose, docker, orchestration, cli, reference
title: Compose command-line reference
notoc: true
---
The following pages describe the usage information for the [docker-compose](overview.md) subcommands. You can also see this information by running `docker-compose [SUBCOMMAND] --help` from the command line.
@@ -35,4 +36,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

@@ -2,6 +2,7 @@
description: Forces running containers to stop.
keywords: fig, composition, compose, docker, orchestration, cli, kill
title: docker-compose kill
notoc: true
---
```

View File

@@ -2,6 +2,7 @@
description: Displays log output from services.
keywords: fig, composition, compose, docker, orchestration, cli, logs
title: docker-compose logs
notoc: true
---
```
@@ -15,4 +16,4 @@ Options:
for each container.
```
Displays log output from services.
Displays log output from services.

View File

@@ -4,6 +4,7 @@ keywords: fig, composition, compose, docker, orchestration, cli, docker-compose
redirect_from:
- /compose/reference/docker-compose/
title: Overview of docker-compose CLI
notoc: true
---
This page provides the usage information for the `docker-compose` Command.

View File

@@ -2,10 +2,11 @@
description: Pauses running containers for a service.
keywords: fig, composition, compose, docker, orchestration, cli, pause
title: docker-compose pause
notoc: true
---
```
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

@@ -2,6 +2,7 @@
description: Prints the public port for a port binding.s
keywords: fig, composition, compose, docker, orchestration, cli, port
title: docker-compose port
notoc: true
---
```
@@ -13,4 +14,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

@@ -2,6 +2,7 @@
description: Lists containers.
keywords: fig, composition, compose, docker, orchestration, cli, ps
title: docker-compose ps
notoc: true
---
```none
@@ -19,4 +20,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

@@ -2,6 +2,7 @@
description: Pulls service images.
keywords: fig, composition, compose, docker, orchestration, cli, pull
title: docker-compose pull
notoc: true
---
```
@@ -11,4 +12,4 @@ Options:
--ignore-pull-failures Pull what it can and ignores images with pull failures.
```
Pulls service images.
Pulls service images.

View File

@@ -2,6 +2,7 @@
description: Pushes service images.
keywords: fig, composition, compose, docker, orchestration, cli, push
title: docker-compose push
notoc: true
---
```
@@ -11,4 +12,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

@@ -2,6 +2,7 @@
description: Restarts Docker Compose services.
keywords: fig, composition, compose, docker, orchestration, cli, restart
title: docker-compose restart
notoc: true
---
```

View File

@@ -2,6 +2,7 @@
description: Removes stopped service containers.
keywords: fig, composition, compose, docker, orchestration, cli, rm
title: docker-compose rm
notoc: true
---
```
@@ -19,4 +20,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

@@ -2,6 +2,7 @@
description: Runs a one-off command on a service.
keywords: fig, composition, compose, docker, orchestration, cli, run
title: docker-compose run
notoc: true
---
```

View File

@@ -2,6 +2,7 @@
description: Sets the number of containers to run for a service.
keywords: fig, composition, compose, docker, orchestration, cli, scale
title: docker-compose scale
notoc: true
---
```

View File

@@ -2,10 +2,11 @@
description: Starts existing containers for a service.
keywords: fig, composition, compose, docker, orchestration, cli, start
title: docker-compose start
notoc: true
---
```
Usage: start [SERVICE...]
```
Starts existing containers for a service.
Starts existing containers for a service.

View File

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

View File

@@ -2,6 +2,7 @@
description: Displays the running processes.
keywords: fig, composition, compose, docker, orchestration, cli, top
title: docker-compose top
notoc: true
---
```none
@@ -22,4 +23,4 @@ compose_service_b_1
PID USER TIME COMMAND
----------------------------
4115 root 0:00 top
```
```

View File

@@ -2,10 +2,11 @@
description: Unpauses paused containers for a service.
keywords: fig, composition, compose, docker, orchestration, cli, unpause
title: docker-compose unpause
notoc: true
---
```
Usage: unpause [SERVICE...]
```
Unpauses paused containers of a service.
Unpauses paused containers of a service.

View File

@@ -2,6 +2,7 @@
description: Builds, (re)creates, starts, and attaches to containers for a service.
keywords: fig, composition, compose, docker, orchestration, cli, up
title: docker-compose up
notoc: true
---
```
@@ -45,4 +46,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

@@ -2,6 +2,7 @@
description: How to control service startup order in Docker Compose
keywords: documentation, docs, docker, compose, startup, order
title: Controlling startup order in Compose
notoc: true
---
You can control the order of service startup with the