Merge pull request #1016 from SvenDowideit/docs-tweak

Add an index to the bottom of the Compose docs as they're scattered arou...

docs/cli.md

@@ -5,8 +5,8 @@ page_keywords: fig, composition, compose, docker, orchestration, cli, reference
 
 # CLI reference
 
-Most commands are run against one or more services. If the service is not
-specified, the command will apply to all services.
+Most Docker Compose commands are run against one or more services. If
+the service is not specified, the command will apply to all services.
 
 For full usage information, run `docker-compose [COMMAND] --help`.
 
@@ -172,9 +172,10 @@ the daemon.
 
 Configures the path to the `ca.pem`, `cert.pem`, and `key.pem` files used for TLS verification. Defaults to `~/.docker`.
 
-## Compose Documentation
+## Compose documentation
 
 - [Installing Compose](install.md)
-- [Intro & Overview](index.md)
+- [User guide](index.md)
 - [Yaml file reference](yml.md)
-
+- [Compose environment variables](env.md)
+- [Compose command line completion](completion.md)

docs/completion.md

@@ -31,3 +31,11 @@ Depending on what you typed on the command line so far, it will complete
  - arguments for selected options, e.g. `docker-compose kill -s` will complete some signals like SIGHUP and SIGUSR1.
 
 Enjoy working with Compose faster and with less typos!
+
+## Compose documentation
+
+- [Installing Compose](install.md)
+- [User guide](index.md)
+- [Command line reference](cli.md)
+- [Yaml file reference](yml.md)
+- [Compose environment variables](env.md)

docs/django.md

@@ -89,3 +89,11 @@ You can also run management commands with Docker. To set up your database, for e
 
     $ docker-compose run web python manage.py syncdb
 
+## Compose documentation
+
+- [Installing Compose](install.md)
+- [User guide](index.md)
+- [Command line reference](cli.md)
+- [Yaml file reference](yml.md)
+- [Compose environment variables](env.md)
+- [Compose command line completion](completion.md)

docs/env.md

@@ -31,3 +31,11 @@ Protocol (tcp or udp), e.g. `DB_PORT_5432_TCP_PROTO=tcp`
 Fully qualified container name, e.g. `DB_1_NAME=/myapp_web_1/myapp_db_1`
 
 [Docker links]: http://docs.docker.com/userguide/dockerlinks/
+
+## Compose documentation
+
+- [Installing Compose](install.md)
+- [User guide](index.md)
+- [Command line reference](cli.md)
+- [Yaml file reference](yml.md)
+- [Compose command line completion](completion.md)

docs/index.md

@@ -178,6 +178,12 @@ your services once you've finished with them:
 
     $ docker-compose stop
 
-At this point, you have seen the basics of how Compose works. See the reference
-guides for complete details on the [commands](cli.md), the [configuration
-file](yml.md) and [environment variables](env.md).
+At this point, you have seen the basics of how Compose works. 
+
+## Compose documentation
+
+- [Installing Compose](install.md)
+- [Command line reference](cli.md)
+- [Yaml file reference](yml.md)
+- [Compose environment variables](env.md)
+- [Compose command line completion](completion.md)

docs/install.md

@@ -42,3 +42,11 @@ Compose can also be installed as a Python package:
 
 No further steps are required; Compose should now be successfully  installed.
 You can test the installation by running `docker-compose --version`.
+
+## Compose documentation
+
+- [User guide](index.md)
+- [Command line reference](cli.md)
+- [Yaml file reference](yml.md)
+- [Compose environment variables](env.md)
+- [Compose command line completion](completion.md)

docs/rails.md

@@ -94,3 +94,12 @@ Finally, we just need to create the database. In another terminal, run:
     $ docker-compose run web rake db:create
 
 And we're rolling—your app should now be running on port 3000 on your docker daemon (if you're using boot2docker, `boot2docker ip` will tell you its address).
+
+## Compose documentation
+
+- [Installing Compose](install.md)
+- [User guide](index.md)
+- [Command line reference](cli.md)
+- [Yaml file reference](yml.md)
+- [Compose environment variables](env.md)
+- [Compose command line completion](completion.md)

docs/wordpress.md

@@ -89,3 +89,12 @@ if(file_exists($root.$path))
 ```
 
 With those four files in place, run `docker-compose up` inside your Wordpress directory and it'll pull and build the images we need, and then start the web and database containers. You'll then be able to visit Wordpress at port 8000 on your docker daemon (if you're using boot2docker, `boot2docker ip` will tell you its address).
+
+## Compose documentation
+
+- [Installing Compose](install.md)
+- [User guide](index.md)
+- [Command line reference](cli.md)
+- [Yaml file reference](yml.md)
+- [Compose environment variables](env.md)
+- [Compose command line completion](completion.md)

docs/yml.md

@@ -29,8 +29,10 @@ image: a4bc65fd
 
 ### build
 
-Path to a directory containing a Dockerfile. Compose will build and tag it
-with a generated name, and use that image thereafter.
+Path to a directory containing a Dockerfile. This directory is also the
+build context that is sent to the Docker daemon.
+
+Compose will build and tag it with a generated name, and use that image thereafter.
 
 ```
 build: /path/to/build/dir
@@ -237,3 +239,11 @@ restart: always
 stdin_open: true
 tty: true
 ```
+
+## Compose documentation
+
+- [Installing Compose](install.md)
+- [User guide](index.md)
+- [Command line reference](cli.md)
+- [Compose environment variables](env.md)
+- [Compose command line completion](completion.md)