From 11b2121105c4fc6141976269dfe04b07c77ea798 Mon Sep 17 00:00:00 2001 From: Sven Dowideit Date: Mon, 23 Feb 2015 14:30:48 +1000 Subject: [PATCH] add ./script/doc to build swarm documentation using the docs.docker.com tooling Signed-off-by: Sven Dowideit --- docs/Dockerfile | 21 +++++++++++++++++++++ docs/build.sh | 11 +++++++++++ userguide.md => docs/index.md | 4 ++-- docs/mkdocs.yml | 6 ++++++ 4 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 docs/Dockerfile create mode 100755 docs/build.sh rename userguide.md => docs/index.md (95%) create mode 100644 docs/mkdocs.yml diff --git a/docs/Dockerfile b/docs/Dockerfile new file mode 100644 index 0000000000..8815045e61 --- /dev/null +++ b/docs/Dockerfile @@ -0,0 +1,21 @@ +FROM docs/base:latest +MAINTAINER Sven Dowideit (@SvenDowideit) + +# to get the git info for this repo +COPY . /src + +# Reset the /docs dir so we can replace the theme meta with the new repo's git info +RUN git reset --hard + +RUN grep "VERSION =" /src/version/version.go | sed 's/.*"\(.*\)".*/\1/' > /docs/VERSION +COPY docs/mkdocs.yml /docs/mkdocs-swarm.yml + +COPY ./scheduler/strategy/README.md /docs/sources/swarm/scheduler/strategy.md +COPY ./scheduler/filter/README.md /docs/sources/swarm/scheduler/filter.md +COPY ./api/README.md /docs/sources/swarm/API.md +COPY ./discovery/README.md /docs/sources/swarm/discovery.md +#COPY ./discovery/token/README.md /docs/sources/ +COPY ./docs/index.md /docs/sources/swarm/index.md + +# Then build everything together, ready for mkdocs +RUN /docs/build.sh diff --git a/docs/build.sh b/docs/build.sh new file mode 100755 index 0000000000..31c58861d0 --- /dev/null +++ b/docs/build.sh @@ -0,0 +1,11 @@ +#!/bin/sh +set -ex + +# import the existing docs build cmds from docker/docker +DOCSPORT=8000 +GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD 2>/dev/null) +DOCKER_DOCS_IMAGE="compose-docs$GIT_BRANCH" +DOCKER_RUN_DOCS="docker run --rm -it -e NOCACHE" + +docker build -t "$DOCKER_DOCS_IMAGE" -f docs/Dockerfile . +$DOCKER_RUN_DOCS -p $DOCSPORT:8000 "$DOCKER_DOCS_IMAGE" mkdocs serve diff --git a/userguide.md b/docs/index.md similarity index 95% rename from userguide.md rename to docs/index.md index e6c0d72f71..ca709260a2 100644 --- a/userguide.md +++ b/docs/index.md @@ -91,9 +91,9 @@ the certificates. ## Discovery services -See the [Discovery service](../discovery) document for more information. +See the [Discovery service](discovery.md) document for more information. ## Advanced Scheduling -See [filters](../scheduler/filter) and [strategies](../scheduler/strategy) to learn +See [filters](scheduler/filter.md) and [strategies](scheduler/strategy.md) to learn more about advanced scheduling. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000000..beeb1eeef6 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,6 @@ + +- ['swarm/index.md', 'User Guide', 'Docker Swarm' ] +- ['swarm/discovery.md', 'Reference', 'Swarm discovery'] +- ['swarm/API.md', 'Reference', 'Swarm API'] +- ['swarm/scheduler/filter.md', 'Reference', 'Swarm filters'] +- ['swarm/scheduler/strategy.md', 'Reference', 'Swarm strategies']