Merge pull request #2179 from moxiegirl/retooling-hugo-15

Updating to new tooling:supports Github source linking
This commit is contained in:
Daniel Nephin 2015-10-13 18:12:56 -04:00
commit c06d9ec672
15 changed files with 44 additions and 114 deletions

View File

@ -1,10 +1,11 @@
FROM docs/base:latest FROM docs/base:hugo-github-linking
MAINTAINER Mary Anthony <mary@docker.com> (@moxiegirl) MAINTAINER Mary Anthony <mary@docker.com> (@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/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/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/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/tutorials/trunk/docs /docs/content/tutorials
RUN svn checkout https://github.com/docker/opensource/trunk/docs /docs/content 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 . /src
COPY . /docs/content/compose/ 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

View File

@ -59,10 +59,10 @@ Enjoy working with Compose faster and with less typos!
## Compose documentation ## Compose documentation
- [User guide](/) - [User guide](index.md)
- [Installing Compose](install.md) - [Installing Compose](install.md)
- [Get started with Django](django.md) - [Get started with Django](django.md)
- [Get started with Rails](rails.md) - [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md) - [Get started with WordPress](wordpress.md)
- [Command line reference](/reference) - [Command line reference](./reference/index.md)
- [Yaml file reference](yml.md) - [Yaml file reference](yml.md)

View File

@ -124,10 +124,10 @@ example, run `docker-compose up` and in another terminal run:
## More Compose documentation ## More Compose documentation
- [User guide](/) - [User guide](../index.md)
- [Installing Compose](install.md) - [Installing Compose](install.md)
- [Get started with Django](django.md) - [Get started with Django](django.md)
- [Get started with Rails](rails.md) - [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md) - [Get started with WordPress](wordpress.md)
- [Command line reference](/reference) - [Command line reference](./reference/index.md)
- [Yaml file reference](yml.md) - [Yaml file reference](yml.md)

View File

@ -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/ [Docker links]: http://docs.docker.com/userguide/dockerlinks/
## Compose documentation ## Related Information
- [User guide](/) - [User guide](index.md)
- [Installing Compose](install.md) - [Installing Compose](install.md)
- [Command line reference](/reference) - [Command line reference](./reference/index.md)
- [Yaml file reference](yml.md) - [Yaml file reference](yml.md)

View File

@ -358,5 +358,5 @@ locally-defined bindings taking precedence:
- [Get started with Django](django.md) - [Get started with Django](django.md)
- [Get started with Rails](rails.md) - [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md) - [Get started with WordPress](wordpress.md)
- [Command line reference](/reference) - [Command line reference](./reference/index.md)
- [Yaml file reference](yml.md) - [Yaml file reference](yml.md)

View File

@ -53,7 +53,7 @@ Compose has commands for managing the whole lifecycle of your application:
- [Get started with Django](django.md) - [Get started with Django](django.md)
- [Get started with Rails](rails.md) - [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md) - [Get started with WordPress](wordpress.md)
- [Command line reference](/reference) - [Command line reference](./reference/index.md)
- [Yaml file reference](yml.md) - [Yaml file reference](yml.md)
## Quick start ## 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), - Next, try the quick start guide for [Django](django.md),
[Rails](rails.md), or [WordPress](wordpress.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). [configuration file](yml.md) and [environment variables](env.md).
## Release Notes ## Release Notes

View File

@ -129,5 +129,5 @@ To uninstall Docker Compose if you installed using `pip`:
- [Get started with Django](django.md) - [Get started with Django](django.md)
- [Get started with Rails](rails.md) - [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md) - [Get started with WordPress](wordpress.md)
- [Command line reference](/reference) - [Command line reference](./reference/index.md)
- [Yaml file reference](yml.md) - [Yaml file reference](yml.md)

View File

@ -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 '/^<!.*metadata]>/g' \
-e '/^<!.*end-metadata.*>/g' {} \;
;;
*)
y=${i##*/}
find $i -type f -name "*.md" -exec sed -i.old \
-e '/^<!.*metadata]>/g' \
-e '/^<!.*end-metadata.*>/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

View File

@ -89,5 +89,5 @@ guide</a>.
- [Get started with Django](django.md) - [Get started with Django](django.md)
- [Get started with Rails](rails.md) - [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md) - [Get started with WordPress](wordpress.md)
- [Command line reference](/reference) - [Command line reference](./reference/index.md)
- [Yaml file reference](yml.md) - [Yaml file reference](yml.md)

View File

@ -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 Django](django.md)
- [Get started with Rails](rails.md) - [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md) - [Get started with WordPress](wordpress.md)
- [Command line reference](/reference) - [Command line reference](./reference/index.md)
- [Yaml file reference](yml.md) - [Yaml file reference](yml.md)

View File

@ -100,5 +100,5 @@ directory name.
## Where to go next ## Where to go next
* [CLI environment variables](/reference/overview.md) * [CLI environment variables](overview.md)
* [Command line reference](/reference) * [Command line reference](index.md)

View File

@ -11,24 +11,24 @@ parent = "smn_compose_ref"
## Compose CLI reference ## 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) * [build](build.md)
* [help](/reference/help.md) * [help](help.md)
* [kill](/reference/kill.md) * [kill](kill.md)
* [ps](/reference/ps.md) * [ps](ps.md)
* [restart](/reference/restart.md) * [restart](restart.md)
* [run](/reference/run.md) * [run](run.md)
* [start](/reference/start.md) * [start](start.md)
* [up](/reference/up.md) * [up](up.md)
* [logs](/reference/logs.md) * [logs](logs.md)
* [port](/reference/port.md) * [port](port.md)
* [pull](/reference/pull.md) * [pull](pull.md)
* [rm](/reference/rm.md) * [rm](rm.md)
* [scale](/reference/scale.md) * [scale](scale.md)
* [stop](/reference/stop.md) * [stop](stop.md)
## Where to go next ## Where to go next
* [CLI environment variables](/reference/overview) * [CLI environment variables](overview.md)
* [docker-compose Command](/reference/docker-compose) * [docker-compose Command](docker-compose.md)

View File

@ -17,8 +17,8 @@ This section describes the subcommands you can use with the `docker-compose` com
## Commands ## Commands
* [docker-compose Command](/reference/docker-compose.md) * [docker-compose Command](docker-compose.md)
* [CLI Reference](/reference) * [CLI Reference](index.md)
## Environment Variables ## 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. it failed. Defaults to 60 seconds.
## Compose documentation ## Related Information
- [User guide](/) - [User guide](../index.md)
- [Installing Compose](install.md) - [Installing Compose](../install.md)
- [Yaml file reference](yml.md) - [Yaml file reference](../yml.md)

View File

@ -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 Django](django.md)
- [Get started with Rails](rails.md) - [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md) - [Get started with WordPress](wordpress.md)
- [Command line reference](/reference) - [Command line reference](./reference/index.md)
- [Yaml file reference](yml.md) - [Yaml file reference](yml.md)

View File

@ -415,9 +415,9 @@ dollar sign (`$$`).
## Compose documentation ## Compose documentation
- [User guide](/) - [User guide](index.md)
- [Installing Compose](install.md) - [Installing Compose](install.md)
- [Get started with Django](django.md) - [Get started with Django](django.md)
- [Get started with Rails](rails.md) - [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md) - [Get started with WordPress](wordpress.md)
- [Command line reference](/reference) - [Command line reference](./reference/index.md)