Skip to content

Commit 4a70dd4

Browse files
author
Victoria Bialas
committed
removed on-page topic menu from ref pages
Signed-off-by: Victoria Bialas <[email protected]>
1 parent 15dc27f commit 4a70dd4

30 files changed

+54
-23
lines changed

compose/env-file.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Declare default environment variables in a file
33
keywords: fig, composition, compose, docker, orchestration, environment, env file
44
title: Declare default environment variables in file
5+
notoc: true
56
---
67

78
Compose supports declaring default environment variables in an environment
@@ -34,4 +35,4 @@ file, but can also be used to define the following
3435

3536
- [User guide](index.md)
3637
- [Command line reference](./reference/index.md)
37-
- [Compose file reference](compose-file.md)
38+
- [Compose file reference](compose-file.md)

compose/link-env-deprecated.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ keywords: fig, composition, compose, docker, orchestration, cli, reference
44
redirect_from:
55
- /compose/env
66
title: Link environment variables (superseded)
7+
notoc: true
78
---
89

910
> **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`
3940
- [User guide](index.md)
4041
- [Installing Compose](install.md)
4142
- [Command line reference](./reference/index.md)
42-
- [Compose file reference](compose-file.md)
43+
- [Compose file reference](compose-file.md)

compose/reference/build.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
description: docker-compose build
33
keywords: fig, composition, compose, docker, orchestration, cli, build
44
title: docker-compose build
5+
notoc: true
6+
57
---
68

79
```
@@ -15,4 +17,4 @@ Options:
1517

1618
Services are built once and then tagged as `project_service`, e.g.,
1719
`composetest_db`. If you change a service's Dockerfile or the contents of its
18-
build directory, run `docker-compose build` to rebuild it.
20+
build directory, run `docker-compose build` to rebuild it.

compose/reference/bundle.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Create a distributed application bundle from the Compose file.
33
keywords: fig, composition, compose, docker, orchestration, cli, bundle
44
title: docker-compose bundle
5+
notoc: true
56
---
67

78
```
@@ -21,4 +22,4 @@ Images must have digests stored, which requires interaction with a
2122
Docker registry. If digests aren't stored for all images, you can fetch
2223
them with `docker-compose pull` or `docker-compose push`. To push images
2324
automatically when bundling, pass `--push-images`. Only services with
24-
a `build` option specified will have their images pushed.
25+
a `build` option specified will have their images pushed.

compose/reference/config.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Config validates and view the compose file.
33
keywords: fig, composition, compose, docker, orchestration, cli, config
44
title: docker-compose config
5+
notoc: true
56
---
67

78
```:
@@ -13,4 +14,4 @@ Options:
1314
--services Print the service names, one per line.
1415
```
1516

16-
Validate and view the compose file.
17+
Validate and view the compose file.

compose/reference/create.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Create creates containers for a service.
33
keywords: fig, composition, compose, docker, orchestration, cli, create
44
title: docker-compose create
5+
notoc: true
56
---
67

78
```
@@ -16,4 +17,4 @@ Options:
1617
Incompatible with --force-recreate.
1718
--no-build Don't build an image, even if it's missing.
1819
--build Build images before creating containers.
19-
```
20+
```

compose/reference/down.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: docker-compose down
33
keywords: fig, composition, compose, docker, orchestration, cli, down
44
title: docker-compose down
5+
notoc: true
56
---
67

78
```
@@ -28,4 +29,4 @@ By default, the only things removed are:
2829
- Networks defined in the `networks` section of the Compose file
2930
- The default network, if one is used
3031

31-
Networks and volumes defined as `external` are never removed.
32+
Networks and volumes defined as `external` are never removed.

compose/reference/envvars.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Compose CLI environment variables
33
keywords: fig, composition, compose, docker, orchestration, cli, reference
44
title: Compose CLI environment variables
5+
notoc: true
56
---
67

78
Several environment variables are available for you to configure the Docker Compose command-line behaviour.

compose/reference/events.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Receive real time events from containers.
33
keywords: fig, composition, compose, docker, orchestration, cli, events
44
title: docker-compose events
5+
notoc: true
56
---
67

78
```
@@ -24,4 +25,4 @@ format:
2425
"image": "alpine:edge",
2526
"time": "2015-11-20T18:01:03.615550",
2627
}
27-
```
28+
```

compose/reference/exec.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: docker-compose exec
33
keywords: fig, composition, compose, docker, orchestration, cli, exec
44
title: docker-compose exec
5+
notoc: true
56
---
67

78
```
@@ -19,4 +20,4 @@ Options:
1920

2021
This is equivalent of `docker exec`. With this subcommand you can run arbitrary
2122
commands in your services. Commands are by default allocating a TTY, so you can
22-
do e.g. `docker-compose exec web sh` to get an interactive prompt.
23+
do e.g. `docker-compose exec web sh` to get an interactive prompt.

compose/reference/help.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22
description: docker-compose help
33
keywords: fig, composition, compose, docker, orchestration, cli, help
44
title: docker-compose help
5+
notoc: true
56
---
67

78
```
89
Usage: help COMMAND
910
```
1011

11-
Displays help and usage instructions for a command.
12+
Displays help and usage instructions for a command.

compose/reference/index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Compose CLI reference
33
keywords: fig, composition, compose, docker, orchestration, cli, reference
44
title: Compose command-line reference
5+
notoc: true
56
---
67

78
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
3536
## Where to go next
3637

3738
* [CLI environment variables](envvars.md)
38-
* [docker-compose Command](overview.md)
39+
* [docker-compose Command](overview.md)

compose/reference/kill.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Forces running containers to stop.
33
keywords: fig, composition, compose, docker, orchestration, cli, kill
44
title: docker-compose kill
5+
notoc: true
56
---
67

78
```

compose/reference/logs.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Displays log output from services.
33
keywords: fig, composition, compose, docker, orchestration, cli, logs
44
title: docker-compose logs
5+
notoc: true
56
---
67

78
```
@@ -15,4 +16,4 @@ Options:
1516
for each container.
1617
```
1718

18-
Displays log output from services.
19+
Displays log output from services.

compose/reference/overview.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ keywords: fig, composition, compose, docker, orchestration, cli, docker-compose
44
redirect_from:
55
- /compose/reference/docker-compose/
66
title: Overview of docker-compose CLI
7+
notoc: true
78
---
89

910
This page provides the usage information for the `docker-compose` Command.

compose/reference/pause.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22
description: Pauses running containers for a service.
33
keywords: fig, composition, compose, docker, orchestration, cli, pause
44
title: docker-compose pause
5+
notoc: true
56
---
67

78
```
89
Usage: pause [SERVICE...]
910
```
1011

11-
Pauses running containers of a service. They can be unpaused with `docker-compose unpause`.
12+
Pauses running containers of a service. They can be unpaused with `docker-compose unpause`.

compose/reference/port.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Prints the public port for a port binding.s
33
keywords: fig, composition, compose, docker, orchestration, cli, port
44
title: docker-compose port
5+
notoc: true
56
---
67

78
```
@@ -13,4 +14,4 @@ Options:
1314
instances of a service [default: 1]
1415
```
1516

16-
Prints the public port for a port binding.
17+
Prints the public port for a port binding.

compose/reference/ps.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Lists containers.
33
keywords: fig, composition, compose, docker, orchestration, cli, ps
44
title: docker-compose ps
5+
notoc: true
56
---
67

78
```none
@@ -19,4 +20,4 @@ $ docker-compose ps
1920
--------------------------------------------------------------------------------------------
2021
mywordpress_db_1 docker-entrypoint.sh mysqld Up 3306/tcp
2122
mywordpress_wordpress_1 /entrypoint.sh apache2-for ... Restarting 0.0.0.0:8000->80/tcp
22-
```
23+
```

compose/reference/pull.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Pulls service images.
33
keywords: fig, composition, compose, docker, orchestration, cli, pull
44
title: docker-compose pull
5+
notoc: true
56
---
67

78
```
@@ -11,4 +12,4 @@ Options:
1112
--ignore-pull-failures Pull what it can and ignores images with pull failures.
1213
```
1314

14-
Pulls service images.
15+
Pulls service images.

compose/reference/push.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Pushes service images.
33
keywords: fig, composition, compose, docker, orchestration, cli, push
44
title: docker-compose push
5+
notoc: true
56
---
67

78
```
@@ -11,4 +12,4 @@ Options:
1112
--ignore-push-failures Push what it can and ignores images with push failures.
1213
```
1314

14-
Pushes images for services.
15+
Pushes images for services.

compose/reference/restart.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Restarts Docker Compose services.
33
keywords: fig, composition, compose, docker, orchestration, cli, restart
44
title: docker-compose restart
5+
notoc: true
56
---
67

78
```

compose/reference/rm.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Removes stopped service containers.
33
keywords: fig, composition, compose, docker, orchestration, cli, rm
44
title: docker-compose rm
5+
notoc: true
56
---
67

78
```
@@ -19,4 +20,4 @@ Removes stopped service containers.
1920
By default, anonymous volumes attached to containers will not be removed. You
2021
can override this with `-v`. To list all volumes, use `docker volume ls`.
2122

22-
Any data which is not in a volume will be lost.
23+
Any data which is not in a volume will be lost.

compose/reference/run.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Runs a one-off command on a service.
33
keywords: fig, composition, compose, docker, orchestration, cli, run
44
title: docker-compose run
5+
notoc: true
56
---
67

78
```

compose/reference/scale.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Sets the number of containers to run for a service.
33
keywords: fig, composition, compose, docker, orchestration, cli, scale
44
title: docker-compose scale
5+
notoc: true
56
---
67

78
```

compose/reference/start.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22
description: Starts existing containers for a service.
33
keywords: fig, composition, compose, docker, orchestration, cli, start
44
title: docker-compose start
5+
notoc: true
56
---
67

78
```
89
Usage: start [SERVICE...]
910
```
1011

11-
Starts existing containers for a service.
12+
Starts existing containers for a service.

compose/reference/stop.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: 'Stops running containers without removing them. '
33
keywords: fig, composition, compose, docker, orchestration, cli, stop
44
title: docker-compose stop
5+
notoc: true
56
---
67

78
```
@@ -12,4 +13,4 @@ Options:
1213
```
1314

1415
Stops running containers without removing them. They can be started again with
15-
`docker-compose start`.
16+
`docker-compose start`.

compose/reference/top.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Displays the running processes.
33
keywords: fig, composition, compose, docker, orchestration, cli, top
44
title: docker-compose top
5+
notoc: true
56
---
67

78
```none
@@ -22,4 +23,4 @@ compose_service_b_1
2223
PID USER TIME COMMAND
2324
----------------------------
2425
4115 root 0:00 top
25-
```
26+
```

compose/reference/unpause.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22
description: Unpauses paused containers for a service.
33
keywords: fig, composition, compose, docker, orchestration, cli, unpause
44
title: docker-compose unpause
5+
notoc: true
56
---
67

78
```
89
Usage: unpause [SERVICE...]
910
```
1011

11-
Unpauses paused containers of a service.
12+
Unpauses paused containers of a service.

compose/reference/up.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Builds, (re)creates, starts, and attaches to containers for a service.
33
keywords: fig, composition, compose, docker, orchestration, cli, up
44
title: docker-compose up
5+
notoc: true
56
---
67

78
```
@@ -45,4 +46,4 @@ volumes). To prevent Compose from picking up changes, use the `--no-recreate`
4546
flag.
4647

4748
If you want to force Compose to stop and recreate all containers, use the
48-
`--force-recreate` flag.
49+
`--force-recreate` flag.

compose/startup-order.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: How to control service startup order in Docker Compose
33
keywords: documentation, docs, docker, compose, startup, order
44
title: Controlling startup order in Compose
5+
notoc: true
56
---
67

78
You can control the order of service startup with the

0 commit comments

Comments
 (0)