From 4a70dd4cb22d9c18f8d1474ba8967e1dd57f8d55 Mon Sep 17 00:00:00 2001 From: Victoria Bialas Date: Fri, 17 Feb 2017 18:02:58 -0800 Subject: [PATCH] removed on-page topic menu from ref pages Signed-off-by: Victoria Bialas --- compose/env-file.md | 3 ++- compose/link-env-deprecated.md | 3 ++- compose/reference/build.md | 4 +++- compose/reference/bundle.md | 3 ++- compose/reference/config.md | 3 ++- compose/reference/create.md | 3 ++- compose/reference/down.md | 3 ++- compose/reference/envvars.md | 1 + compose/reference/events.md | 3 ++- compose/reference/exec.md | 3 ++- compose/reference/help.md | 3 ++- compose/reference/index.md | 3 ++- compose/reference/kill.md | 1 + compose/reference/logs.md | 3 ++- compose/reference/overview.md | 1 + compose/reference/pause.md | 3 ++- compose/reference/port.md | 3 ++- compose/reference/ps.md | 3 ++- compose/reference/pull.md | 3 ++- compose/reference/push.md | 3 ++- compose/reference/restart.md | 1 + compose/reference/rm.md | 3 ++- compose/reference/run.md | 1 + compose/reference/scale.md | 1 + compose/reference/start.md | 3 ++- compose/reference/stop.md | 3 ++- compose/reference/top.md | 3 ++- compose/reference/unpause.md | 3 ++- compose/reference/up.md | 3 ++- compose/startup-order.md | 1 + 30 files changed, 54 insertions(+), 23 deletions(-) diff --git a/compose/env-file.md b/compose/env-file.md index 12aac5eadb..2254803fec 100644 --- a/compose/env-file.md +++ b/compose/env-file.md @@ -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) \ No newline at end of file +- [Compose file reference](compose-file.md) diff --git a/compose/link-env-deprecated.md b/compose/link-env-deprecated.md index 0cfb9583fa..0a7a162363 100644 --- a/compose/link-env-deprecated.md +++ b/compose/link-env-deprecated.md @@ -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) \ No newline at end of file +- [Compose file reference](compose-file.md) diff --git a/compose/reference/build.md b/compose/reference/build.md index 51703c258b..1f73082534 100644 --- a/compose/reference/build.md +++ b/compose/reference/build.md @@ -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. \ No newline at end of file +build directory, run `docker-compose build` to rebuild it. diff --git a/compose/reference/bundle.md b/compose/reference/bundle.md index f916481236..9b6354ac9b 100644 --- a/compose/reference/bundle.md +++ b/compose/reference/bundle.md @@ -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. \ No newline at end of file +a `build` option specified will have their images pushed. diff --git a/compose/reference/config.md b/compose/reference/config.md index 369a7694de..f60eae70e4 100644 --- a/compose/reference/config.md +++ b/compose/reference/config.md @@ -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. \ No newline at end of file +Validate and view the compose file. diff --git a/compose/reference/create.md b/compose/reference/create.md index 00c4fed197..b45f165a70 100644 --- a/compose/reference/create.md +++ b/compose/reference/create.md @@ -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. -``` \ No newline at end of file +``` diff --git a/compose/reference/down.md b/compose/reference/down.md index 4a1348a7d8..638c0a8ad8 100644 --- a/compose/reference/down.md +++ b/compose/reference/down.md @@ -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. \ No newline at end of file +Networks and volumes defined as `external` are never removed. diff --git a/compose/reference/envvars.md b/compose/reference/envvars.md index 12b160f559..4a00b0d386 100644 --- a/compose/reference/envvars.md +++ b/compose/reference/envvars.md @@ -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. diff --git a/compose/reference/events.md b/compose/reference/events.md index 4c08345092..b3558aa19f 100644 --- a/compose/reference/events.md +++ b/compose/reference/events.md @@ -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", } -``` \ No newline at end of file +``` diff --git a/compose/reference/exec.md b/compose/reference/exec.md index edc7260243..e8087b1e33 100644 --- a/compose/reference/exec.md +++ b/compose/reference/exec.md @@ -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. \ No newline at end of file +do e.g. `docker-compose exec web sh` to get an interactive prompt. diff --git a/compose/reference/help.md b/compose/reference/help.md index 956c295ea0..3ce82c4302 100644 --- a/compose/reference/help.md +++ b/compose/reference/help.md @@ -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. \ No newline at end of file +Displays help and usage instructions for a command. diff --git a/compose/reference/index.md b/compose/reference/index.md index 04b9f3b3f3..235ae7ef58 100644 --- a/compose/reference/index.md +++ b/compose/reference/index.md @@ -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) \ No newline at end of file +* [docker-compose Command](overview.md) diff --git a/compose/reference/kill.md b/compose/reference/kill.md index 77396dae56..a72873d8b0 100644 --- a/compose/reference/kill.md +++ b/compose/reference/kill.md @@ -2,6 +2,7 @@ description: Forces running containers to stop. keywords: fig, composition, compose, docker, orchestration, cli, kill title: docker-compose kill +notoc: true --- ``` diff --git a/compose/reference/logs.md b/compose/reference/logs.md index ea33bcb407..297ff334e4 100644 --- a/compose/reference/logs.md +++ b/compose/reference/logs.md @@ -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. \ No newline at end of file +Displays log output from services. diff --git a/compose/reference/overview.md b/compose/reference/overview.md index ca57b16027..a75433be81 100644 --- a/compose/reference/overview.md +++ b/compose/reference/overview.md @@ -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. diff --git a/compose/reference/pause.md b/compose/reference/pause.md index 9bf42351d9..9f0147d728 100644 --- a/compose/reference/pause.md +++ b/compose/reference/pause.md @@ -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`. \ No newline at end of file +Pauses running containers of a service. They can be unpaused with `docker-compose unpause`. diff --git a/compose/reference/port.md b/compose/reference/port.md index da70ff90f0..96051ba507 100644 --- a/compose/reference/port.md +++ b/compose/reference/port.md @@ -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. \ No newline at end of file +Prints the public port for a port binding. diff --git a/compose/reference/ps.md b/compose/reference/ps.md index 9bdd1ca44b..24bd3e01ad 100644 --- a/compose/reference/ps.md +++ b/compose/reference/ps.md @@ -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 -``` \ No newline at end of file +``` diff --git a/compose/reference/pull.md b/compose/reference/pull.md index db53eb53e1..ccfe66fa54 100644 --- a/compose/reference/pull.md +++ b/compose/reference/pull.md @@ -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. \ No newline at end of file +Pulls service images. diff --git a/compose/reference/push.md b/compose/reference/push.md index 73f4f4da92..ab9c677b15 100644 --- a/compose/reference/push.md +++ b/compose/reference/push.md @@ -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. \ No newline at end of file +Pushes images for services. diff --git a/compose/reference/restart.md b/compose/reference/restart.md index f85aa739d4..e449ba546d 100644 --- a/compose/reference/restart.md +++ b/compose/reference/restart.md @@ -2,6 +2,7 @@ description: Restarts Docker Compose services. keywords: fig, composition, compose, docker, orchestration, cli, restart title: docker-compose restart +notoc: true --- ``` diff --git a/compose/reference/rm.md b/compose/reference/rm.md index 9646100f8f..ec33d5744b 100644 --- a/compose/reference/rm.md +++ b/compose/reference/rm.md @@ -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. \ No newline at end of file +Any data which is not in a volume will be lost. diff --git a/compose/reference/run.md b/compose/reference/run.md index 5717694f66..fec994f4c7 100644 --- a/compose/reference/run.md +++ b/compose/reference/run.md @@ -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 --- ``` diff --git a/compose/reference/scale.md b/compose/reference/scale.md index 834a075869..881756e8ff 100644 --- a/compose/reference/scale.md +++ b/compose/reference/scale.md @@ -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 --- ``` diff --git a/compose/reference/start.md b/compose/reference/start.md index 719c8147cc..8d9d0cd1f4 100644 --- a/compose/reference/start.md +++ b/compose/reference/start.md @@ -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. \ No newline at end of file +Starts existing containers for a service. diff --git a/compose/reference/stop.md b/compose/reference/stop.md index 62f4cb5943..2da3ff2669 100644 --- a/compose/reference/stop.md +++ b/compose/reference/stop.md @@ -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`. \ No newline at end of file +`docker-compose start`. diff --git a/compose/reference/top.md b/compose/reference/top.md index 106347e341..5f71cb44f1 100644 --- a/compose/reference/top.md +++ b/compose/reference/top.md @@ -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 -``` \ No newline at end of file +``` diff --git a/compose/reference/unpause.md b/compose/reference/unpause.md index 0e33775224..83b79e6111 100644 --- a/compose/reference/unpause.md +++ b/compose/reference/unpause.md @@ -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. \ No newline at end of file +Unpauses paused containers of a service. diff --git a/compose/reference/up.md b/compose/reference/up.md index f24a5aa88c..3bfd8dff22 100644 --- a/compose/reference/up.md +++ b/compose/reference/up.md @@ -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. \ No newline at end of file +`--force-recreate` flag. diff --git a/compose/startup-order.md b/compose/startup-order.md index 1df82a6c3d..55c5350f9e 100644 --- a/compose/startup-order.md +++ b/compose/startup-order.md @@ -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