Skip to content

Commit 8563a00

Browse files
committed
compose: move reference/overview page
This makes the compose command-line reference available at; https://docs.docker.com/compose/reference/ Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 91ac76a commit 8563a00

File tree

9 files changed

+12
-12
lines changed

9 files changed

+12
-12
lines changed

_data/toc.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -948,7 +948,7 @@ reference:
948948
title: docker wait
949949
- sectiontitle: Docker Compose CLI reference
950950
section:
951-
- path: /compose/reference/overview/
951+
- path: /compose/reference/
952952
title: Overview of docker-compose CLI
953953
- path: /compose/reference/envvars/
954954
title: CLI environment variables

compose/extends.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ the rules described in
3131
To use multiple override files, or an override file with a different name, you
3232
can use the `-f` option to specify the list of files. Compose merges files in
3333
the order they're specified on the command line. See the
34-
[`docker-compose` command reference](reference/overview.md) for more information
34+
[`docker-compose` command reference](reference/index.md) for more information
3535
about using `-f`.
3636

3737
When you use multiple configuration files, you must make sure all paths in the

compose/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ handling `SIGTERM` properly.
5757

5858
Compose uses the project name to create unique identifiers for all of a
5959
project's containers and other resources. To run multiple copies of a project,
60-
set a custom project name using the [`-p` command line option](reference/overview.md)
60+
set a custom project name using the [`-p` command line option](reference/index.md)
6161
or the [`COMPOSE_PROJECT_NAME` environment variable](reference/envvars.md#compose_project_name).
6262

6363
## What's the difference between `up`, `run`, and `start`?

compose/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Compose uses a project name to isolate environments from each other. You can mak
9292
9393
The default project name is the basename of the project directory. You can set
9494
a custom project name by using the
95-
[`-p` command line option](reference/overview.md) or the
95+
[`-p` command line option](reference/index.md) or the
9696
[`COMPOSE_PROJECT_NAME` environment variable](reference/envvars.md#compose_project_name).
9797

9898
The default project directory is the base directory of the Compose file. A custom value

compose/networking.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ identical to the container name.
1616
>
1717
> Your app's network is given a name based on the "project name",
1818
> which is based on the name of the directory it lives in. You can override the
19-
> project name with either the [`--project-name` flag](reference/overview.md)
19+
> project name with either the [`--project-name` flag](reference/index.md)
2020
> or the [`COMPOSE_PROJECT_NAME` environment variable](reference/envvars.md#compose_project_name).
2121
2222
For example, suppose your app is in a directory called `myapp`, and your `docker-compose.yml` looks like this:

compose/profiles.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Valid profile names follow the regex format of `[a-zA-Z0-9][a-zA-Z0-9_.-]+`.
5757

5858
## Enabling profiles
5959

60-
To enable a profile supply the `--profile` [command-line option](reference/overview.md) or
60+
To enable a profile supply the `--profile` [command-line option](reference/index.md) or
6161
use the [`COMPOSE_PROFILES` environment variable](reference/envvars.md#compose_profiles):
6262

6363
```sh

compose/reference/envvars.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ includes two services `db` and `web`, then Compose starts containers named
2121

2222
Setting this is optional. If you do not set this, the `COMPOSE_PROJECT_NAME`
2323
defaults to the `basename` of the project directory. See also the `-p`
24-
[command-line option](overview.md).
24+
[command-line option](index.md).
2525

2626
## COMPOSE\_FILE
2727

@@ -34,7 +34,7 @@ Linux and macOS the path separator is `:`, on Windows it is `;`). For example:
3434
`COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml`. The path separator
3535
can also be customized using `COMPOSE_PATH_SEPARATOR`.
3636

37-
See also the `-f` [command-line option](overview.md).
37+
See also the `-f` [command-line option](index.md).
3838

3939
## COMPOSE\_PROFILES
4040

@@ -47,7 +47,7 @@ You can specify a list of profiles separated with a comma:
4747
`debug`.
4848

4949
See also [_Using profiles with Compose_](../profiles.md) and the `--profile`
50-
[command-line option](overview.md).
50+
[command-line option](index.md#use---profile-to-specify-one-or-more-active-profiles).
5151

5252
## COMPOSE\_API\_VERSION
5353

compose/reference/overview.md renamed to compose/reference/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
description: Overview of docker-compose CLI
33
keywords: fig, composition, compose, docker, orchestration, cli, reference, docker-compose
44
redirect_from:
5-
- /compose/reference/
65
- /compose/reference/docker-compose/
6+
- /compose/reference/overview/
77
title: Overview of docker-compose CLI
88
---
99

reference/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ various APIs, CLIs, and file formats.
1212
| File format | Description |
1313
|:--------------------------------------------------------------------|:----------------------------------------------------------------|
1414
| [Dockerfile](/engine/reference/builder/) | Defines the contents and startup behavior of a single container |
15-
| [Compose file](/compose/compose-file/) | Defines a multi-container application |
15+
| [Compose file](/compose/compose-file/index.md) | Defines a multi-container application |
1616

1717

1818
## Command-line interfaces (CLIs)
1919

2020
| CLI | Description |
2121
|:---------------------------------------------------------------|:-------------------------------------------------------------------------------------------|
2222
| [Docker CLI](/engine/reference/commandline/cli/) | The main CLI for Docker, includes all `docker` commands |
23-
| [Compose CLI](/compose/reference/overview/) | The CLI for Docker Compose, which allows you to build and run multi-container applications |
23+
| [Compose CLI](/compose/reference/index.md) | The CLI for Docker Compose, which allows you to build and run multi-container applications |
2424
| [Daemon CLI (dockerd)](/engine/reference/commandline/dockerd/) | Persistent process that manages containers |
2525

2626

0 commit comments

Comments
 (0)