From 8563a00ad85cdd18c0d1dd046d45875812426613 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Mon, 19 Apr 2021 10:54:04 +0200 Subject: [PATCH] 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 --- _data/toc.yaml | 2 +- compose/extends.md | 2 +- compose/faq.md | 2 +- compose/index.md | 2 +- compose/networking.md | 2 +- compose/profiles.md | 2 +- compose/reference/envvars.md | 6 +++--- compose/reference/{overview.md => index.md} | 2 +- reference/index.md | 4 ++-- 9 files changed, 12 insertions(+), 12 deletions(-) rename compose/reference/{overview.md => index.md} (99%) diff --git a/_data/toc.yaml b/_data/toc.yaml index aacb082768..65d2b5c8ea 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -948,7 +948,7 @@ reference: title: docker wait - sectiontitle: Docker Compose CLI reference section: - - path: /compose/reference/overview/ + - path: /compose/reference/ title: Overview of docker-compose CLI - path: /compose/reference/envvars/ title: CLI environment variables diff --git a/compose/extends.md b/compose/extends.md index 7f0ff158b1..2e5677dc6a 100644 --- a/compose/extends.md +++ b/compose/extends.md @@ -31,7 +31,7 @@ the rules described in To use multiple override files, or an override file with a different name, you can use the `-f` option to specify the list of files. Compose merges files in the order they're specified on the command line. See the -[`docker-compose` command reference](reference/overview.md) for more information +[`docker-compose` command reference](reference/index.md) for more information about using `-f`. When you use multiple configuration files, you must make sure all paths in the diff --git a/compose/faq.md b/compose/faq.md index 6173db213b..276743eb93 100644 --- a/compose/faq.md +++ b/compose/faq.md @@ -57,7 +57,7 @@ handling `SIGTERM` properly. Compose uses the project name to create unique identifiers for all of a project's containers and other resources. To run multiple copies of a project, -set a custom project name using the [`-p` command line option](reference/overview.md) +set a custom project name using the [`-p` command line option](reference/index.md) or the [`COMPOSE_PROJECT_NAME` environment variable](reference/envvars.md#compose_project_name). ## What's the difference between `up`, `run`, and `start`? diff --git a/compose/index.md b/compose/index.md index a8b1baeeb2..d23aa98bc2 100644 --- a/compose/index.md +++ b/compose/index.md @@ -92,7 +92,7 @@ Compose uses a project name to isolate environments from each other. You can mak The default project name is the basename of the project directory. You can set a custom project name by using the -[`-p` command line option](reference/overview.md) or the +[`-p` command line option](reference/index.md) or the [`COMPOSE_PROJECT_NAME` environment variable](reference/envvars.md#compose_project_name). The default project directory is the base directory of the Compose file. A custom value diff --git a/compose/networking.md b/compose/networking.md index 24893b6fc4..a983bd4176 100644 --- a/compose/networking.md +++ b/compose/networking.md @@ -16,7 +16,7 @@ identical to the container name. > > Your app's network is given a name based on the "project name", > which is based on the name of the directory it lives in. You can override the -> project name with either the [`--project-name` flag](reference/overview.md) +> project name with either the [`--project-name` flag](reference/index.md) > or the [`COMPOSE_PROJECT_NAME` environment variable](reference/envvars.md#compose_project_name). For example, suppose your app is in a directory called `myapp`, and your `docker-compose.yml` looks like this: diff --git a/compose/profiles.md b/compose/profiles.md index 10bf772b28..0a203924a2 100644 --- a/compose/profiles.md +++ b/compose/profiles.md @@ -57,7 +57,7 @@ Valid profile names follow the regex format of `[a-zA-Z0-9][a-zA-Z0-9_.-]+`. ## Enabling profiles -To enable a profile supply the `--profile` [command-line option](reference/overview.md) or +To enable a profile supply the `--profile` [command-line option](reference/index.md) or use the [`COMPOSE_PROFILES` environment variable](reference/envvars.md#compose_profiles): ```sh diff --git a/compose/reference/envvars.md b/compose/reference/envvars.md index ae318f5baa..ce0bc70ad2 100644 --- a/compose/reference/envvars.md +++ b/compose/reference/envvars.md @@ -21,7 +21,7 @@ includes two services `db` and `web`, then Compose starts containers named Setting this is optional. If you do not set this, the `COMPOSE_PROJECT_NAME` defaults to the `basename` of the project directory. See also the `-p` -[command-line option](overview.md). +[command-line option](index.md). ## COMPOSE\_FILE @@ -34,7 +34,7 @@ Linux and macOS the path separator is `:`, on Windows it is `;`). For example: `COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml`. The path separator can also be customized using `COMPOSE_PATH_SEPARATOR`. -See also the `-f` [command-line option](overview.md). +See also the `-f` [command-line option](index.md). ## COMPOSE\_PROFILES @@ -47,7 +47,7 @@ You can specify a list of profiles separated with a comma: `debug`. See also [_Using profiles with Compose_](../profiles.md) and the `--profile` -[command-line option](overview.md). +[command-line option](index.md#use---profile-to-specify-one-or-more-active-profiles). ## COMPOSE\_API\_VERSION diff --git a/compose/reference/overview.md b/compose/reference/index.md similarity index 99% rename from compose/reference/overview.md rename to compose/reference/index.md index 924c5a7c18..d7a6a74947 100644 --- a/compose/reference/overview.md +++ b/compose/reference/index.md @@ -2,8 +2,8 @@ description: Overview of docker-compose CLI keywords: fig, composition, compose, docker, orchestration, cli, reference, docker-compose redirect_from: -- /compose/reference/ - /compose/reference/docker-compose/ +- /compose/reference/overview/ title: Overview of docker-compose CLI --- diff --git a/reference/index.md b/reference/index.md index 55030de53e..11f8c1ef81 100644 --- a/reference/index.md +++ b/reference/index.md @@ -12,7 +12,7 @@ various APIs, CLIs, and file formats. | File format | Description | |:--------------------------------------------------------------------|:----------------------------------------------------------------| | [Dockerfile](/engine/reference/builder/) | Defines the contents and startup behavior of a single container | -| [Compose file](/compose/compose-file/) | Defines a multi-container application | +| [Compose file](/compose/compose-file/index.md) | Defines a multi-container application | ## Command-line interfaces (CLIs) @@ -20,7 +20,7 @@ various APIs, CLIs, and file formats. | CLI | Description | |:---------------------------------------------------------------|:-------------------------------------------------------------------------------------------| | [Docker CLI](/engine/reference/commandline/cli/) | The main CLI for Docker, includes all `docker` commands | -| [Compose CLI](/compose/reference/overview/) | The CLI for Docker Compose, which allows you to build and run multi-container applications | +| [Compose CLI](/compose/reference/index.md) | The CLI for Docker Compose, which allows you to build and run multi-container applications | | [Daemon CLI (dockerd)](/engine/reference/commandline/dockerd/) | Persistent process that manages containers |