From 07a053763f1bab8677e93b1b95e1850a35b3fd84 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 22 Aug 2024 15:45:42 +0200 Subject: [PATCH] compose: use plugin base cmd as cli overview Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- .../compose/environment-variables/envvars.md | 6 +- content/compose/reference/_index.md | 81 ------------------- .../get-started/workshop/08_using_compose.md | 2 +- content/language/cpp/containerize.md | 2 +- content/language/dotnet/containerize.md | 2 +- content/language/java/containerize.md | 2 +- content/language/nodejs/containerize.md | 2 +- content/language/php/containerize.md | 2 +- content/language/python/containerize.md | 2 +- content/language/r/containerize.md | 2 +- content/language/ruby/containerize.md | 2 +- content/reference/_index.md | 2 +- .../reference/cli/docker/compose/_index.md | 1 + data/toc.yaml | 6 +- 14 files changed, 16 insertions(+), 98 deletions(-) delete mode 100644 content/compose/reference/_index.md diff --git a/content/compose/environment-variables/envvars.md b/content/compose/environment-variables/envvars.md index 6b469e826f..eb76c08f14 100644 --- a/content/compose/environment-variables/envvars.md +++ b/content/compose/environment-variables/envvars.md @@ -60,7 +60,7 @@ underscores, and must begin with a lowercase letter or decimal digit. If the `basename` of the project directory or current directory violates this constraint, you must use one of the other mechanisms. -See also the [command-line options overview](../reference/index.md#command-options-overview-and-help) and [using `-p` to specify a project name](../reference/index.md#use--p-to-specify-a-project-name). +See also the [command-line options overview](/reference/cli/docker/compose/_index.md#command-options-overview-and-help) and [using `-p` to specify a project name](/reference/cli/docker/compose/_index.md#use--p-to-specify-a-project-name). ### COMPOSE\_FILE @@ -75,7 +75,7 @@ The path separator can also be customized using `COMPOSE_PATH_SEPARATOR`. Example: `COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml`. -See also the [command-line options overview](../reference/index.md#command-options-overview-and-help) and [using `-f` to specify name and path of one or more Compose files](../reference/index.md#use--f-to-specify-name-and-path-of-one-or-more-compose-files). +See also the [command-line options overview](/reference/cli/docker/compose/_index.md#command-options-overview-and-help) and [using `-f` to specify name and path of one or more Compose files](/reference/cli/docker/compose/_index.md#use--f-to-specify-name-and-path-of-one-or-more-compose-files). ### COMPOSE\_PROFILES @@ -90,7 +90,7 @@ For example, calling `docker compose up`with `COMPOSE_PROFILES=frontend` selects Example: `COMPOSE_PROFILES=frontend,debug` This example enables all services matching both the `frontend` and `debug` profiles and services without a profile. -See also [Using profiles with Compose](../profiles.md) and the [`--profile` command-line option](../reference/index.md#use---profile-to-specify-one-or-more-active-profiles). +See also [Using profiles with Compose](../profiles.md) and the [`--profile` command-line option](/reference/cli/docker/compose/_index.md#use---profile-to-specify-one-or-more-active-profiles). ### COMPOSE\_CONVERT\_WINDOWS\_PATHS diff --git a/content/compose/reference/_index.md b/content/compose/reference/_index.md deleted file mode 100644 index dbbabe2cef..0000000000 --- a/content/compose/reference/_index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -description: Overview of the Docker Compose CLI -keywords: fig, composition, compose, docker, orchestration, cli, reference, docker-compose -title: Overview of docker compose CLI -aliases: -- /compose/reference/overview/ ---- - -This page provides usage information for the `docker compose` command. - -## Command options overview and help - -You can also see this information by running `docker compose --help` from the -command line. - -```text -Usage: docker compose [OPTIONS] COMMAND - -Define and run multi-container applications with Docker - -Options: - --all-resources Include all resources, even those not used by services - --ansi string Control when to print ANSI control characters ("never"|"always"|"auto") (default "auto") - --compatibility Run compose in backward compatibility mode - --dry-run Execute command in dry run mode - --env-file stringArray Specify an alternate environment file - -f, --file stringArray Compose configuration files - --parallel int Control max parallelism, -1 for unlimited (default -1) - --profile stringArray Specify a profile to enable - --progress string Set type of progress output (auto, tty, plain, quiet) (default "auto") - --project-directory string Specify an alternate working directory - (default: the path of the, first specified, Compose file) - -p, --project-name string Project name - -Commands: - attach Attach local standard input, output, and error streams to a service's running container - build Build or rebuild services - config Parse, resolve and render compose file in canonical format - cp Copy files/folders between a service container and the local filesystem - create Creates containers for a service - down Stop and remove containers, networks - events Receive real time events from containers - exec Execute a command in a running container - images List images used by the created containers - kill Force stop service containers - logs View output from containers - ls List running compose projects - pause Pause services - port Print the public port for a port binding - ps List containers - pull Pull service images - push Push service images - restart Restart service containers - rm Removes stopped service containers - run Run a one-off command on a service - scale Scale services - start Start services - stats Display a live stream of container(s) resource usage statistics - stop Stop services - top Display the running processes - unpause Unpause services - up Create and start containers - version Show the Docker Compose version information - wait Block until the first service container stops - watch Watch build context for service and rebuild/refresh containers when files are updated - - -Run 'docker compose COMMAND --help' for more information on a command. -``` - -You can use Docker Compose binary, `docker compose [-f ...] [options] -[COMMAND] [ARGS...]`, to build and manage multiple services in Docker containers. - -## Useful resources - -- [How Compose works](../compose-application-model.md) -- [Quickstart](../gettingstarted.md) -- [Specify a project name](../project-name.md) -- [Using environment variables](../environment-variables/_index.md) -- [Working with multiple Compose files](../multiple-compose-files/_index.md) -- [Compose Specification](/reference/compose-file/_index.md) diff --git a/content/get-started/workshop/08_using_compose.md b/content/get-started/workshop/08_using_compose.md index 5042fdd290..58adf2407c 100644 --- a/content/get-started/workshop/08_using_compose.md +++ b/content/get-started/workshop/08_using_compose.md @@ -281,7 +281,7 @@ the way you define and share multi-service applications. Related information: - [Compose overview](/compose/_index.md) - [Compose file reference](/reference/compose-file/_index.md) - - [Compose CLI reference](/compose/reference/_index.md) + - [Compose CLI reference](/reference/cli/docker/compose/_index.md) ## Next steps diff --git a/content/language/cpp/containerize.md b/content/language/cpp/containerize.md index 28857332d7..8235552296 100644 --- a/content/language/cpp/containerize.md +++ b/content/language/cpp/containerize.md @@ -71,7 +71,7 @@ $ docker compose down ``` For more information about Compose commands, see the [Compose CLI -reference](../../compose/reference/_index.md). +reference](/reference/cli/docker/compose/_index.md). ## Summary diff --git a/content/language/dotnet/containerize.md b/content/language/dotnet/containerize.md index ee5cfa20aa..2d08e74afa 100644 --- a/content/language/dotnet/containerize.md +++ b/content/language/dotnet/containerize.md @@ -111,7 +111,7 @@ $ docker compose down ``` For more information about Compose commands, see the [Compose CLI -reference](../../compose/reference/_index.md). +reference](/reference/cli/docker/compose/_index.md). ## Summary diff --git a/content/language/java/containerize.md b/content/language/java/containerize.md index fc6dbf8728..3e715c2348 100644 --- a/content/language/java/containerize.md +++ b/content/language/java/containerize.md @@ -315,7 +315,7 @@ $ docker compose down ``` For more information about Compose commands, see the -[Compose CLI reference](../../compose/reference/_index.md). +[Compose CLI reference](/reference/cli/docker/compose/_index.md). ## Summary diff --git a/content/language/nodejs/containerize.md b/content/language/nodejs/containerize.md index 0992e329fd..32119ff377 100644 --- a/content/language/nodejs/containerize.md +++ b/content/language/nodejs/containerize.md @@ -266,7 +266,7 @@ $ docker compose down ``` For more information about Compose commands, see the [Compose CLI -reference](../../compose/reference/_index.md). +reference](/reference/cli/docker/compose/_index.md). ## Summary diff --git a/content/language/php/containerize.md b/content/language/php/containerize.md index 85c42f961e..715d0544e7 100644 --- a/content/language/php/containerize.md +++ b/content/language/php/containerize.md @@ -112,7 +112,7 @@ $ docker compose down ``` For more information about Compose commands, see the [Compose CLI -reference](../../compose/reference/_index.md). +reference](/reference/cli/docker/compose/_index.md). ## Summary diff --git a/content/language/python/containerize.md b/content/language/python/containerize.md index 3c521c8a5c..105fe2df04 100644 --- a/content/language/python/containerize.md +++ b/content/language/python/containerize.md @@ -356,7 +356,7 @@ $ docker compose down ``` For more information about Compose commands, see the [Compose CLI -reference](../../compose/reference/_index.md). +reference](/reference/cli/docker/compose/_index.md). ## Summary diff --git a/content/language/r/containerize.md b/content/language/r/containerize.md index e372493dcd..f51a99b328 100644 --- a/content/language/r/containerize.md +++ b/content/language/r/containerize.md @@ -78,7 +78,7 @@ $ docker compose down ``` For more information about Compose commands, see the [Compose CLI -reference](../../compose/reference/_index.md). +reference](/reference/cli/docker/compose/_index.md). ## Summary diff --git a/content/language/ruby/containerize.md b/content/language/ruby/containerize.md index 819fcaf068..8b7b70b75e 100644 --- a/content/language/ruby/containerize.md +++ b/content/language/ruby/containerize.md @@ -377,7 +377,7 @@ $ docker compose down ``` For more information about Compose commands, see the [Compose CLI -reference](../../compose/reference/_index.md). +reference](/reference/cli/docker/compose/_index.md). ## Summary diff --git a/content/reference/_index.md b/content/reference/_index.md index 64642dedc3..43487c8126 100644 --- a/content/reference/_index.md +++ b/content/reference/_index.md @@ -20,7 +20,7 @@ grid_clis: description: The CLI for Docker Compose, for building and running multi-container applications. icon: subtitles - link: /compose/reference/ + link: /reference/cli/docker/compose/ - title: Daemon CLI (dockerd) description: Persistent process that manages containers. icon: developer_board diff --git a/content/reference/cli/docker/compose/_index.md b/content/reference/cli/docker/compose/_index.md index 753713ec12..680385642e 100644 --- a/content/reference/cli/docker/compose/_index.md +++ b/content/reference/cli/docker/compose/_index.md @@ -6,6 +6,7 @@ aliases: - /compose/reference/docker-compose/ - /compose/reference/help/ - /engine/reference/commandline/compose/ +- /compose/reference/ layout: cli --- diff --git a/data/toc.yaml b/data/toc.yaml index c1d423d773..eb67570f30 100644 --- a/data/toc.yaml +++ b/data/toc.yaml @@ -413,8 +413,8 @@ Reference: title: docker checkpoint rm - sectiontitle: docker compose section: - - path: /compose/reference/ - title: overview + - path: /reference/cli/docker/compose/ + title: docker compose - path: /reference/cli/docker/compose/alpha/ title: docker compose alpha - path: /reference/cli/docker/compose/alpha/dry-run/ @@ -425,8 +425,6 @@ Reference: title: docker compose alpha scale - path: /reference/cli/docker/compose/alpha/viz/ title: docker compose alpha viz - - path: /reference/cli/docker/compose/ - title: docker compose - path: /reference/cli/docker/compose/build/ title: docker compose build - path: /reference/cli/docker/compose/config/