From 0e9c542865215a7ff8333e11e9eaa45b4e5a92c1 Mon Sep 17 00:00:00 2001 From: Mary Anthony Date: Tue, 13 Oct 2015 04:01:19 -0700 Subject: [PATCH 1/2] Updating to new tooling:supports Github source linking Fixing HEAD Updating to match daniel Fixing the index link Signed-off-by: Mary Anthony --- docs/Dockerfile | 16 ++------- docs/completion.md | 4 +-- docs/django.md | 4 +-- docs/env.md | 6 ++-- docs/extends.md | 2 +- docs/index.md | 4 +-- docs/install.md | 2 +- docs/pre-process.sh | 60 -------------------------------- docs/production.md | 2 +- docs/rails.md | 2 +- docs/reference/docker-compose.md | 4 +-- docs/reference/index.md | 34 +++++++++--------- docs/reference/overview.md | 12 +++---- docs/wordpress.md | 2 +- docs/yml.md | 6 ++-- 15 files changed, 46 insertions(+), 114 deletions(-) delete mode 100755 docs/pre-process.sh diff --git a/docs/Dockerfile b/docs/Dockerfile index fcd64900b..0114f04e4 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -1,10 +1,11 @@ -FROM docs/base:latest +FROM docs/base:hugo-github-linking MAINTAINER Mary Anthony (@moxiegirl) -RUN svn checkout https://github.com/docker/docker/trunk/docs /docs/content/docker +RUN svn checkout https://github.com/docker/docker/trunk/docs /docs/content/engine 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 RUN svn checkout https://github.com/docker/distribution/trunk/docs /docs/content/registry +RUN svn checkout https://github.com/kitematic/kitematic/trunk/docs /docs/content/kitematic 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 @@ -12,14 +13,3 @@ RUN svn checkout https://github.com/docker/opensource/trunk/docs /docs/content COPY . /src COPY . /docs/content/compose/ - -# Sed to process GitHub Markdown -# 1-2 Remove comment code from metadata block -# 3 Change ](/word to ](/project/ in links -# 4 Change ](word.md) to ](/project/word) -# 5 Remove .md extension from link text -# 6 Change ](../ to ](/project/word) -# 7 Change ](../../ to ](/project/ --> not implemented -# -# -RUN /src/pre-process.sh /docs diff --git a/docs/completion.md b/docs/completion.md index 30c555c3a..6e7b42c26 100644 --- a/docs/completion.md +++ b/docs/completion.md @@ -59,10 +59,10 @@ Enjoy working with Compose faster and with less typos! ## Compose documentation -- [User guide](/) +- [User guide](index.md) - [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) +- [Command line reference](./reference/index.md) - [Yaml file reference](yml.md) diff --git a/docs/django.md b/docs/django.md index b11e16935..f4775c4ec 100644 --- a/docs/django.md +++ b/docs/django.md @@ -124,10 +124,10 @@ example, run `docker-compose up` and in another terminal run: ## More Compose documentation -- [User guide](/) +- [User guide](../index.md) - [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) +- [Command line reference](./reference/index.md) - [Yaml file reference](yml.md) diff --git a/docs/env.md b/docs/env.md index 8886548e2..984a340bb 100644 --- a/docs/env.md +++ b/docs/env.md @@ -37,9 +37,9 @@ 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 +## Related Information -- [User guide](/) +- [User guide](index.md) - [Installing Compose](install.md) -- [Command line reference](/reference) +- [Command line reference](./reference/index.md) - [Yaml file reference](yml.md) diff --git a/docs/extends.md b/docs/extends.md index 8c35c7a66..88fb24a57 100644 --- a/docs/extends.md +++ b/docs/extends.md @@ -358,5 +358,5 @@ locally-defined bindings taking precedence: - [Get started with Django](django.md) - [Get started with Rails](rails.md) - [Get started with WordPress](wordpress.md) -- [Command line reference](/reference) +- [Command line reference](./reference/index.md) - [Yaml file reference](yml.md) diff --git a/docs/index.md b/docs/index.md index 4b9f29d20..bff741b6d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -53,7 +53,7 @@ Compose has commands for managing the whole lifecycle of your application: - [Get started with Django](django.md) - [Get started with Rails](rails.md) - [Get started with WordPress](wordpress.md) -- [Command line reference](/reference) +- [Command line reference](./reference/index.md) - [Yaml file reference](yml.md) ## Quick start @@ -195,7 +195,7 @@ At this point, you have seen the basics of how Compose works. - Next, try the quick start guide for [Django](django.md), [Rails](rails.md), or [WordPress](wordpress.md). -- See the reference guides for complete details on the [commands](/reference), the +- See the reference guides for complete details on the [commands](./reference/index.md), the [configuration file](yml.md) and [environment variables](env.md). ## Release Notes diff --git a/docs/install.md b/docs/install.md index a701f2985..654f6421d 100644 --- a/docs/install.md +++ b/docs/install.md @@ -129,5 +129,5 @@ To uninstall Docker Compose if you installed using `pip`: - [Get started with Django](django.md) - [Get started with Rails](rails.md) - [Get started with WordPress](wordpress.md) -- [Command line reference](/reference) +- [Command line reference](./reference/index.md) - [Yaml file reference](yml.md) diff --git a/docs/pre-process.sh b/docs/pre-process.sh deleted file mode 100755 index f1f6b7fec..000000000 --- a/docs/pre-process.sh +++ /dev/null @@ -1,60 +0,0 @@ -#!/bin/bash -e - -# Populate an array with just docker dirs and one with content dirs -docker_dir=(`ls -d /docs/content/docker/*`) -content_dir=(`ls -d /docs/content/*`) - -# Loop content not of docker/ -# -# Sed to process GitHub Markdown -# 1-2 Remove comment code from metadata block -# 3 Remove .md extension from link text -# 4 Change ](/ to ](/project/ in links -# 5 Change ](word) to ](/project/word) -# 6 Change ](../../ to ](/project/ -# 7 Change ](../ to ](/project/word) -# -for i in "${content_dir[@]}" -do - : - case $i in - "/docs/content/windows") - ;; - "/docs/content/mac") - ;; - "/docs/content/linux") - ;; - "/docs/content/docker") - y=${i##*/} - find $i -type f -name "*.md" -exec sed -i.old \ - -e '/^/g' \ - -e '/^/g' {} \; - ;; - *) - y=${i##*/} - find $i -type f -name "*.md" -exec sed -i.old \ - -e '/^/g' \ - -e '/^/g' \ - -e 's/\(\]\)\([(]\)\(\/\)/\1\2\/'$y'\//g' \ - -e 's/\(\][(]\)\([A-z].*\)\(\.md\)/\1\/'$y'\/\2/g' \ - -e 's/\([(]\)\(.*\)\(\.md\)/\1\2/g' \ - -e 's/\(\][(]\)\(\.\/\)/\1\/'$y'\//g' \ - -e 's/\(\][(]\)\(\.\.\/\.\.\/\)/\1\/'$y'\//g' \ - -e 's/\(\][(]\)\(\.\.\/\)/\1\/'$y'\//g' {} \; - ;; - esac -done - -# -# Move docker directories to content -# -for i in "${docker_dir[@]}" -do - : - if [ -d $i ] - then - mv $i /docs/content/ - fi -done - -rm -rf /docs/content/docker diff --git a/docs/production.md b/docs/production.md index 3e4169e30..5faa1c696 100644 --- a/docs/production.md +++ b/docs/production.md @@ -89,5 +89,5 @@ guide. - [Get started with Django](django.md) - [Get started with Rails](rails.md) - [Get started with WordPress](wordpress.md) -- [Command line reference](/reference) +- [Command line reference](./reference/index.md) - [Yaml file reference](yml.md) diff --git a/docs/rails.md b/docs/rails.md index 3782368d5..74c179b59 100644 --- a/docs/rails.md +++ b/docs/rails.md @@ -128,5 +128,5 @@ That's it. Your app should now be running on port 3000 on your Docker daemon. If - [Get started with Django](django.md) - [Get started with Rails](rails.md) - [Get started with WordPress](wordpress.md) -- [Command line reference](/reference) +- [Command line reference](./reference/index.md) - [Yaml file reference](yml.md) diff --git a/docs/reference/docker-compose.md b/docs/reference/docker-compose.md index b7cca5b08..32fcbe706 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](/reference/overview.md) -* [Command line reference](/reference) +* [CLI environment variables](overview.md) +* [Command line reference](index.md) diff --git a/docs/reference/index.md b/docs/reference/index.md index 961dbb860..b2fb5bcad 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -11,24 +11,24 @@ parent = "smn_compose_ref" ## Compose CLI reference -The following pages describe the usage information for the [docker-compose](/reference/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](docker-compose.md) subcommands. You can also see this information by running `docker-compose [SUBCOMMAND] --help` from the command line. -* [build](/reference/build.md) -* [help](/reference/help.md) -* [kill](/reference/kill.md) -* [ps](/reference/ps.md) -* [restart](/reference/restart.md) -* [run](/reference/run.md) -* [start](/reference/start.md) -* [up](/reference/up.md) -* [logs](/reference/logs.md) -* [port](/reference/port.md) -* [pull](/reference/pull.md) -* [rm](/reference/rm.md) -* [scale](/reference/scale.md) -* [stop](/reference/stop.md) +* [build](build.md) +* [help](help.md) +* [kill](kill.md) +* [ps](ps.md) +* [restart](restart.md) +* [run](run.md) +* [start](start.md) +* [up](up.md) +* [logs](logs.md) +* [port](port.md) +* [pull](pull.md) +* [rm](rm.md) +* [scale](scale.md) +* [stop](stop.md) ## Where to go next -* [CLI environment variables](/reference/overview) -* [docker-compose Command](/reference/docker-compose) +* [CLI environment variables](overview.md) +* [docker-compose Command](docker-compose.md) diff --git a/docs/reference/overview.md b/docs/reference/overview.md index 019525a58..1a4c268b3 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](/reference/docker-compose.md) -* [CLI Reference](/reference) +* [docker-compose Command](docker-compose.md) +* [CLI Reference](index.md) ## Environment Variables @@ -77,8 +77,8 @@ Configures the time (in seconds) a request to the Docker daemon is allowed to ha it failed. Defaults to 60 seconds. -## Compose documentation +## Related Information -- [User guide](/) -- [Installing Compose](install.md) -- [Yaml file reference](yml.md) +- [User guide](../index.md) +- [Installing Compose](../install.md) +- [Yaml file reference](../yml.md) diff --git a/docs/wordpress.md b/docs/wordpress.md index 7ac062899..8c407e447 100644 --- a/docs/wordpress.md +++ b/docs/wordpress.md @@ -98,5 +98,5 @@ database containers. If you're using [Docker Machine](https://docs.docker.com/ma - [Get started with Django](django.md) - [Get started with Rails](rails.md) - [Get started with WordPress](wordpress.md) -- [Command line reference](/reference) +- [Command line reference](./reference/index.md) - [Yaml file reference](yml.md) diff --git a/docs/yml.md b/docs/yml.md index 73fa35dfc..f6ad8b1b7 100644 --- a/docs/yml.md +++ b/docs/yml.md @@ -415,9 +415,11 @@ dollar sign (`$$`). ## Compose documentation -- [User guide](/) +- [User guide](index.md) - [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) +- [Command line reference](./reference/index.md) +- [Compose environment variables](env.md) +- [Compose command line completion](completion.md) From e9ee244e5aab6b686c5b9ae317c37f58d6a6891a Mon Sep 17 00:00:00 2001 From: Mary Anthony Date: Tue, 13 Oct 2015 15:06:37 -0700 Subject: [PATCH 2/2] Aaaaaaaaaaaargh Signed-off-by: Mary Anthony --- docs/yml.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/yml.md b/docs/yml.md index f6ad8b1b7..209d2f180 100644 --- a/docs/yml.md +++ b/docs/yml.md @@ -421,5 +421,3 @@ dollar sign (`$$`). - [Get started with Rails](rails.md) - [Get started with WordPress](wordpress.md) - [Command line reference](./reference/index.md) -- [Compose environment variables](env.md) -- [Compose command line completion](completion.md)