浏览代码

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

Updating to new tooling:supports Github source linking
Daniel Nephin 10 年之前
父节点
当前提交
c06d9ec672
共有 15 个文件被更改,包括 44 次插入114 次删除
  1. 3 13
      docs/Dockerfile
  2. 2 2
      docs/completion.md
  3. 2 2
      docs/django.md
  4. 3 3
      docs/env.md
  5. 1 1
      docs/extends.md
  6. 2 2
      docs/index.md
  7. 1 1
      docs/install.md
  8. 0 60
      docs/pre-process.sh
  9. 1 1
      docs/production.md
  10. 1 1
      docs/rails.md
  11. 2 2
      docs/reference/docker-compose.md
  12. 17 17
      docs/reference/index.md
  13. 6 6
      docs/reference/overview.md
  14. 1 1
      docs/wordpress.md
  15. 2 2
      docs/yml.md

+ 3 - 13
docs/Dockerfile

@@ -1,10 +1,11 @@
-FROM docs/base:latest
+FROM docs/base:hugo-github-linking
 MAINTAINER Mary Anthony <[email protected]> (@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

+ 2 - 2
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)

+ 2 - 2
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)

+ 3 - 3
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)

+ 1 - 1
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)

+ 2 - 2
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

+ 1 - 1
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)

+ 0 - 60
docs/pre-process.sh

@@ -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

+ 1 - 1
docs/production.md

@@ -89,5 +89,5 @@ guide</a>.
 - [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)

+ 1 - 1
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)

+ 2 - 2
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)

+ 17 - 17
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)

+ 6 - 6
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)

+ 1 - 1
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)

+ 2 - 2
docs/yml.md

@@ -415,9 +415,9 @@ 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)