Skip to content

Commit

Permalink
removed on-page topic menu from ref pages
Browse files Browse the repository at this point in the history
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
  • Loading branch information
Victoria Bialas committed Feb 18, 2017
1 parent 15dc27f commit 4a70dd4
Show file tree
Hide file tree
Showing 30 changed files with 54 additions and 23 deletions.
3 changes: 2 additions & 1 deletion compose/env-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
3 changes: 2 additions & 1 deletion compose/link-env-deprecated.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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)
4 changes: 3 additions & 1 deletion compose/reference/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
description: docker-compose build
keywords: fig, composition, compose, docker, orchestration, cli, build
title: docker-compose build
notoc: true

---

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

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

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

```
Expand All @@ -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.
```
```
3 changes: 2 additions & 1 deletion compose/reference/down.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
description: docker-compose down
keywords: fig, composition, compose, docker, orchestration, cli, down
title: docker-compose down
notoc: true
---

```
Expand All @@ -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.
1 change: 1 addition & 0 deletions compose/reference/envvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion compose/reference/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

```
Expand All @@ -24,4 +25,4 @@ format:
"image": "alpine:edge",
"time": "2015-11-20T18:01:03.615550",
}
```
```
3 changes: 2 additions & 1 deletion compose/reference/exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
description: docker-compose exec
keywords: fig, composition, compose, docker, orchestration, cli, exec
title: docker-compose exec
notoc: true
---

```
Expand All @@ -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.
3 changes: 2 additions & 1 deletion compose/reference/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 2 additions & 1 deletion compose/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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)
1 change: 1 addition & 0 deletions compose/reference/kill.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
description: Forces running containers to stop.
keywords: fig, composition, compose, docker, orchestration, cli, kill
title: docker-compose kill
notoc: true
---

```
Expand Down
3 changes: 2 additions & 1 deletion compose/reference/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
description: Displays log output from services.
keywords: fig, composition, compose, docker, orchestration, cli, logs
title: docker-compose logs
notoc: true
---

```
Expand All @@ -15,4 +16,4 @@ Options:
for each container.
```

Displays log output from services.
Displays log output from services.
1 change: 1 addition & 0 deletions compose/reference/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion compose/reference/pause.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
3 changes: 2 additions & 1 deletion compose/reference/port.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

```
Expand All @@ -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.
3 changes: 2 additions & 1 deletion compose/reference/ps.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
description: Lists containers.
keywords: fig, composition, compose, docker, orchestration, cli, ps
title: docker-compose ps
notoc: true
---

```none
Expand All @@ -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
```
```
3 changes: 2 additions & 1 deletion compose/reference/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
description: Pulls service images.
keywords: fig, composition, compose, docker, orchestration, cli, pull
title: docker-compose pull
notoc: true
---

```
Expand All @@ -11,4 +12,4 @@ Options:
--ignore-pull-failures Pull what it can and ignores images with pull failures.
```

Pulls service images.
Pulls service images.
3 changes: 2 additions & 1 deletion compose/reference/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
description: Pushes service images.
keywords: fig, composition, compose, docker, orchestration, cli, push
title: docker-compose push
notoc: true
---

```
Expand All @@ -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.
1 change: 1 addition & 0 deletions compose/reference/restart.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
description: Restarts Docker Compose services.
keywords: fig, composition, compose, docker, orchestration, cli, restart
title: docker-compose restart
notoc: true
---

```
Expand Down
3 changes: 2 additions & 1 deletion compose/reference/rm.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
description: Removes stopped service containers.
keywords: fig, composition, compose, docker, orchestration, cli, rm
title: docker-compose rm
notoc: true
---

```
Expand All @@ -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.
1 change: 1 addition & 0 deletions compose/reference/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

```
Expand Down
1 change: 1 addition & 0 deletions compose/reference/scale.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

```
Expand Down
3 changes: 2 additions & 1 deletion compose/reference/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 2 additions & 1 deletion compose/reference/stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

```
Expand All @@ -12,4 +13,4 @@ Options:
```

Stops running containers without removing them. They can be started again with
`docker-compose start`.
`docker-compose start`.
3 changes: 2 additions & 1 deletion compose/reference/top.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
description: Displays the running processes.
keywords: fig, composition, compose, docker, orchestration, cli, top
title: docker-compose top
notoc: true
---

```none
Expand All @@ -22,4 +23,4 @@ compose_service_b_1
PID USER TIME COMMAND
----------------------------
4115 root 0:00 top
```
```
3 changes: 2 additions & 1 deletion compose/reference/unpause.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 2 additions & 1 deletion compose/reference/up.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

```
Expand Down Expand Up @@ -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.
1 change: 1 addition & 0 deletions compose/startup-order.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4a70dd4

Please sign in to comment.