Move command reference to overview.

Signed-off-by: Daniel Nephin <dnephin@docker.com>
This commit is contained in:
Daniel Nephin 2016-02-01 12:10:21 -05:00
parent cf24c36c55
commit 7b03de7d01
8 changed files with 14 additions and 15 deletions

View File

@ -42,7 +42,7 @@ are copied.
To use multiple override files, or an override file with a different name, you 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 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` the order they're specified on the command line. See the [`docker-compose`
command reference](./reference/docker-compose.md) for more information about command reference](./reference/overview.md) for more information about
using `-f`. using `-f`.
When you use multiple configuration files, you must make sure all paths in the When you use multiple configuration files, you must make sure all paths in the

View File

@ -50,7 +50,7 @@ handling `SIGTERM` properly.
Compose uses the project name to create unique identifiers for all of a 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, project's containers and other resources. To run multiple copies of a project,
set a custom project name using the [`-p` command line set a custom project name using the [`-p` command line
option](./reference/docker-compose.md) or the [`COMPOSE_PROJECT_NAME` option](./reference/overview.md) or the [`COMPOSE_PROJECT_NAME`
environment variable](./reference/envvars.md#compose-project-name). environment variable](./reference/envvars.md#compose-project-name).
## What's the difference between `up`, `run`, and `start`? ## What's the difference between `up`, `run`, and `start`?

View File

@ -1,6 +1,6 @@
<!--[metadata]> <!--[metadata]>
+++ +++
title = "Compose" title = "Docker Compose"
description = "Introduction and Overview of Compose" description = "Introduction and Overview of Compose"
keywords = ["documentation, docs, docker, compose, orchestration, containers"] keywords = ["documentation, docs, docker, compose, orchestration, containers"]
[menu.main] [menu.main]

View File

@ -23,7 +23,7 @@ identical to the container name.
> **Note:** Your app's network is given a name based on the "project name", > **Note:** 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 > which is based on the name of the directory it lives in. You can override the
> project name with either the [`--project-name` > project name with either the [`--project-name`
> flag](reference/docker-compose.md) or the [`COMPOSE_PROJECT_NAME` environment > flag](reference/overview.md) or the [`COMPOSE_PROJECT_NAME` environment
> variable](reference/envvars.md#compose-project-name). > 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: For example, suppose your app is in a directory called `myapp`, and your `docker-compose.yml` looks like this:

View File

@ -92,7 +92,7 @@ this project name to:
The default project name is the basename of the project directory. You can set The default project name is the basename of the project directory. You can set
a custom project name by using the a custom project name by using the
[`-p` command line option](./reference/docker-compose.md) or the [`-p` command line option](./reference/overview.md) or the
[`COMPOSE_PROJECT_NAME` environment variable](./reference/envvars.md#compose-project-name). [`COMPOSE_PROJECT_NAME` environment variable](./reference/envvars.md#compose-project-name).
### Preserve volume data when containers are created ### Preserve volume data when containers are created

View File

@ -3,7 +3,6 @@
title = "CLI Environment Variables" title = "CLI Environment Variables"
description = "CLI Environment Variables" description = "CLI Environment Variables"
keywords = ["fig, composition, compose, docker, orchestration, cli, reference"] keywords = ["fig, composition, compose, docker, orchestration, cli, reference"]
aliases = ["/compose/reference/overview/"]
[menu.main] [menu.main]
parent = "smn_compose_cli" parent = "smn_compose_cli"
weight=-1 weight=-1
@ -24,14 +23,14 @@ Sets the project name. This value is prepended along with the service name to th
Setting this is optional. If you do not set this, the `COMPOSE_PROJECT_NAME` 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` defaults to the `basename` of the project directory. See also the `-p`
[command-line option](docker-compose.md). [command-line option](overview.md).
## COMPOSE\_FILE ## COMPOSE\_FILE
Specify the file containing the compose configuration. If not provided, Specify the file containing the compose configuration. If not provided,
Compose looks for a file named `docker-compose.yml` in the current directory Compose looks for a file named `docker-compose.yml` in the current directory
and then each parent directory in succession until a file by that name is and then each parent directory in succession until a file by that name is
found. See also the `-f` [command-line option](docker-compose.md). found. See also the `-f` [command-line option](overview.md).
## COMPOSE\_API\_VERSION ## COMPOSE\_API\_VERSION

View File

@ -12,9 +12,9 @@ weight=80
## Compose command-line reference ## Compose command-line reference
The following pages describe the usage information for the [docker-compose](docker-compose.md) subcommands. You can also see this information by running `docker-compose [SUBCOMMAND] --help` from the command line. 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.
* [docker-compose](docker-compose.md) * [docker-compose](overview.md)
* [build](build.md) * [build](build.md)
* [config](config.md) * [config](config.md)
* [create](create.md) * [create](create.md)
@ -39,4 +39,4 @@ The following pages describe the usage information for the [docker-compose](dock
## Where to go next ## Where to go next
* [CLI environment variables](envvars.md) * [CLI environment variables](envvars.md)
* [docker-compose Command](docker-compose.md) * [docker-compose Command](overview.md)

View File

@ -1,8 +1,9 @@
<!--[metadata]> <!--[metadata]>
+++ +++
title = "docker-compose Command" title = "Overview of docker-compose CLI"
description = "docker-compose Command Binary" description = "Overview of docker-compose CLI"
keywords = ["fig, composition, compose, docker, orchestration, cli, docker-compose"] keywords = ["fig, composition, compose, docker, orchestration, cli, docker-compose"]
aliases = ["/compose/reference/docker-compose/"]
[menu.main] [menu.main]
parent = "smn_compose_cli" parent = "smn_compose_cli"
weight=-2 weight=-2
@ -10,7 +11,7 @@ weight=-2
<![end-metadata]--> <![end-metadata]-->
# docker-compose Command # Overview of docker-compose CLI
This page provides the usage information for the `docker-compose` Command. This page provides the usage information for the `docker-compose` Command.
You can also see this information by running `docker-compose --help` from the You can also see this information by running `docker-compose --help` from the
@ -114,4 +115,3 @@ envvars.md#compose-project-name)
## Where to go next ## Where to go next
* [CLI environment variables](envvars.md) * [CLI environment variables](envvars.md)
* [Command line reference](index.md)