From 94e6727831f8a6f1abdb49f5763af2b4cffbae3d Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Thu, 8 Oct 2015 14:46:31 -0400 Subject: [PATCH 1/5] Re-order docs Makefile for better caching. Signed-off-by: Daniel Nephin --- docs/Dockerfile | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/Dockerfile b/docs/Dockerfile index d9add75c15..fcd64900b5 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -1,11 +1,6 @@ FROM docs/base:latest MAINTAINER Mary Anthony (@moxiegirl) -# To get the git info for this repo -COPY . /src - -COPY . /docs/content/compose/ - RUN svn checkout https://github.com/docker/docker/trunk/docs /docs/content/docker RUN svn checkout https://github.com/docker/swarm/trunk/docs /docs/content/swarm RUN svn checkout https://github.com/docker/machine/trunk/docs /docs/content/machine @@ -13,6 +8,10 @@ RUN svn checkout https://github.com/docker/distribution/trunk/docs /docs/content RUN svn checkout https://github.com/docker/tutorials/trunk/docs /docs/content/tutorials RUN svn checkout https://github.com/docker/opensource/trunk/docs /docs/content +# To get the git info for this repo +COPY . /src + +COPY . /docs/content/compose/ # Sed to process GitHub Markdown # 1-2 Remove comment code from metadata block From cd48a7026a2e8f97ad4d94548e2b59165a398d7a Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Thu, 8 Oct 2015 17:07:30 -0400 Subject: [PATCH 2/5] Cleanup doc reference links. Removed 'Compose command line completion' and 'Compose environment variables' from the list. command line completion is linked to from install docs, and environment variables are deprecated. Signed-off-by: Daniel Nephin --- docs/completion.md | 1 - docs/django.md | 2 -- docs/env.md | 4 ---- docs/extends.md | 1 - docs/index.md | 13 ------------- docs/install.md | 2 -- docs/production.md | 2 -- docs/rails.md | 2 -- docs/reference/overview.md | 5 ----- docs/wordpress.md | 2 -- docs/yml.md | 2 -- 11 files changed, 36 deletions(-) diff --git a/docs/completion.md b/docs/completion.md index bf8d15551e..891813e911 100644 --- a/docs/completion.md +++ b/docs/completion.md @@ -66,4 +66,3 @@ Enjoy working with Compose faster and with less typos! - [Get started with WordPress](wordpress.md) - [Command line reference](/reference) - [Yaml file reference](yml.md) -- [Compose environment variables](env.md) diff --git a/docs/django.md b/docs/django.md index e52f50301d..b11e169358 100644 --- a/docs/django.md +++ b/docs/django.md @@ -131,5 +131,3 @@ example, run `docker-compose up` and in another terminal run: - [Get started with WordPress](wordpress.md) - [Command line reference](/reference) - [Yaml file reference](yml.md) -- [Compose environment variables](env.md) -- [Compose command line completion](completion.md) diff --git a/docs/env.md b/docs/env.md index a8e6e214ce..8886548e24 100644 --- a/docs/env.md +++ b/docs/env.md @@ -41,9 +41,5 @@ Fully qualified container name, e.g. `DB_1_NAME=/myapp_web_1/myapp_db_1` - [User guide](/) - [Installing Compose](install.md) -- [Get started with Django](django.md) -- [Get started with Rails](rails.md) -- [Get started with WordPress](wordpress.md) - [Command line reference](/reference) - [Yaml file reference](yml.md) -- [Compose command line completion](completion.md) diff --git a/docs/extends.md b/docs/extends.md index 7b4d5b2093..8c35c7a66c 100644 --- a/docs/extends.md +++ b/docs/extends.md @@ -360,4 +360,3 @@ locally-defined bindings taking precedence: - [Get started with WordPress](wordpress.md) - [Command line reference](/reference) - [Yaml file reference](yml.md) -- [Compose command line completion](completion.md) diff --git a/docs/index.md b/docs/index.md index 67a6802b06..7900b4f08f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -55,8 +55,6 @@ Compose has commands for managing the whole lifecycle of your application: - [Get started with WordPress](wordpress.md) - [Command line reference](/reference) - [Yaml file reference](yml.md) -- [Compose environment variables](env.md) -- [Compose command line completion](completion.md) ## Quick start @@ -218,14 +216,3 @@ like-minded individuals, we have a number of open channels for communication. * To contribute code or documentation changes: please submit a [pull request on Github](https://github.com/docker/compose/pulls). For more information and resources, please visit the [Getting Help project page](https://docs.docker.com/project/get-help/). - -## Where to go next - -- [Installing Compose](install.md) -- [Get started with Django](django.md) -- [Get started with Rails](rails.md) -- [Get started with WordPress](wordpress.md) -- [Command line reference](/reference) -- [Yaml file reference](yml.md) -- [Compose environment variables](env.md) -- [Compose command line completion](completion.md) diff --git a/docs/install.md b/docs/install.md index be6a6b26af..363a2b290f 100644 --- a/docs/install.md +++ b/docs/install.md @@ -117,5 +117,3 @@ To uninstall Docker Compose if you installed using `pip`: - [Get started with WordPress](wordpress.md) - [Command line reference](/reference) - [Yaml file reference](yml.md) -- [Compose environment variables](env.md) -- [Compose command line completion](completion.md) diff --git a/docs/production.md b/docs/production.md index 29e3fd34ec..3e4169e308 100644 --- a/docs/production.md +++ b/docs/production.md @@ -91,5 +91,3 @@ guide. - [Get started with WordPress](wordpress.md) - [Command line reference](/reference) - [Yaml file reference](yml.md) -- [Compose environment variables](env.md) -- [Compose command line completion](completion.md) diff --git a/docs/rails.md b/docs/rails.md index 0a164ca75e..c241041005 100644 --- a/docs/rails.md +++ b/docs/rails.md @@ -129,5 +129,3 @@ That's it. Your app should now be running on port 3000 on your Docker daemon. If - [Get started with WordPress](wordpress.md) - [Command line reference](/reference) - [Yaml file reference](yml.md) -- [Compose environment variables](env.md) -- [Compose command line completion](completion.md) diff --git a/docs/reference/overview.md b/docs/reference/overview.md index 9f08246e09..f6496bf786 100644 --- a/docs/reference/overview.md +++ b/docs/reference/overview.md @@ -81,9 +81,4 @@ it failed. Defaults to 60 seconds. - [User guide](/) - [Installing Compose](install.md) -- [Get started with Django](django.md) -- [Get started with Rails](rails.md) -- [Get started with WordPress](wordpress.md) - [Yaml file reference](yml.md) -- [Compose environment variables](env.md) -- [Compose command line completion](completion.md) diff --git a/docs/wordpress.md b/docs/wordpress.md index 621459382b..7ac0628999 100644 --- a/docs/wordpress.md +++ b/docs/wordpress.md @@ -100,5 +100,3 @@ database containers. If you're using [Docker Machine](https://docs.docker.com/ma - [Get started with WordPress](wordpress.md) - [Command line reference](/reference) - [Yaml file reference](yml.md) -- [Compose environment variables](env.md) -- [Compose command line completion](completion.md) diff --git a/docs/yml.md b/docs/yml.md index a476fd33fa..185b31cfc1 100644 --- a/docs/yml.md +++ b/docs/yml.md @@ -418,5 +418,3 @@ dollar sign (`$$`). - [Get started with Rails](rails.md) - [Get started with WordPress](wordpress.md) - [Command line reference](/reference) -- [Compose environment variables](env.md) -- [Compose command line completion](completion.md) From 182c2537d031f822229eca48b9a2b1985191f573 Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Thu, 8 Oct 2015 17:22:42 -0400 Subject: [PATCH 3/5] Fix links between reference sections Signed-off-by: Daniel Nephin --- docs/reference/docker-compose.md | 4 ++-- docs/reference/index.md | 4 ++-- docs/reference/overview.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/reference/docker-compose.md b/docs/reference/docker-compose.md index 32fcbe7064..b7cca5b08e 100644 --- a/docs/reference/docker-compose.md +++ b/docs/reference/docker-compose.md @@ -100,5 +100,5 @@ directory name. ## Where to go next -* [CLI environment variables](overview.md) -* [Command line reference](index.md) +* [CLI environment variables](/reference/overview.md) +* [Command line reference](/reference) diff --git a/docs/reference/index.md b/docs/reference/index.md index 7a1fb9b444..961dbb8605 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -30,5 +30,5 @@ The following pages describe the usage information for the [docker-compose](/ref ## Where to go next -* [CLI environment variables](overview.md) -* [docker-compose Command](docker-compose.md) +* [CLI environment variables](/reference/overview) +* [docker-compose Command](/reference/docker-compose) diff --git a/docs/reference/overview.md b/docs/reference/overview.md index f6496bf786..019525a581 100644 --- a/docs/reference/overview.md +++ b/docs/reference/overview.md @@ -17,8 +17,8 @@ This section describes the subcommands you can use with the `docker-compose` com ## Commands -* [docker-compose Command](docker-compose.md) -* [CLI Reference](index.md) +* [docker-compose Command](/reference/docker-compose.md) +* [CLI Reference](/reference) ## Environment Variables From e90d2b418d7571cf32178d04258f04cecb70dd92 Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Thu, 8 Oct 2015 18:32:05 -0400 Subject: [PATCH 4/5] Update title for command-line completion docs. Signed-off-by: Daniel Nephin --- docs/completion.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/completion.md b/docs/completion.md index 891813e911..30c555c3a7 100644 --- a/docs/completion.md +++ b/docs/completion.md @@ -1,6 +1,6 @@ -# Command Completion +# Command-line Completion Compose comes with [command completion](http://en.wikipedia.org/wiki/Command-line_completion) for the bash and zsh shell. From 9b9c8f9cbcfca5458cfe54daff9a953d5969055a Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Thu, 8 Oct 2015 19:09:01 -0400 Subject: [PATCH 5/5] Clarify irc details, and remove "infancy" statement. Signed-off-by: Daniel Nephin --- docs/index.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 7900b4f08f..4b9f29d204 100644 --- a/docs/index.md +++ b/docs/index.md @@ -205,13 +205,14 @@ Compose, please refer to the [CHANGELOG](https://github.com/docker/compose/blob/ ## Getting help -Docker Compose is still in its infancy and under active development. If you need -help, would like to contribute, or simply want to talk about the project with -like-minded individuals, we have a number of open channels for communication. +Docker Compose is under active development. If you need help, would like to +contribute, or simply want to talk about the project with like-minded +individuals, we have a number of open channels for communication. * To report bugs or file feature requests: please use the [issue tracker on Github](https://github.com/docker/compose/issues). -* To talk about the project with people in real time: please join the `#docker-compose` channel on IRC. +* To talk about the project with people in real time: please join the + `#docker-compose` channel on freenode IRC. * To contribute code or documentation changes: please submit a [pull request on Github](https://github.com/docker/compose/pulls).