docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6631 from SvenDowideit/add-versioning-to-docs-output 

Add versioning to docs output
This commit is contained in:
Sven Dowideit 2014-06-30 11:38:04 +10:00
parent 860d8e9271 5f6a725332
commit 0757a5663a
4 changed files with 32 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -6,6 +6,7 @@ BINDDIR := bundles
DOCSPORT := 8000 DOCSPORT := 8000
GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null) GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null)
GITCOMMIT := $(shell git rev-parse --short HEAD 2>/dev/null)
DOCKER_IMAGE := docker$(if $(GIT_BRANCH),:$(GIT_BRANCH)) DOCKER_IMAGE := docker$(if $(GIT_BRANCH),:$(GIT_BRANCH))
DOCKER_DOCS_IMAGE := docker-docs$(if $(GIT_BRANCH),:$(GIT_BRANCH)) DOCKER_DOCS_IMAGE := docker-docs$(if $(GIT_BRANCH),:$(GIT_BRANCH))
DOCKER_MOUNT := $(if $(BINDDIR),-v "$(CURDIR)/$(BINDDIR):/go/src/github.com/dotcloud/docker/$(BINDDIR)") DOCKER_MOUNT := $(if $(BINDDIR),-v "$(CURDIR)/$(BINDDIR):/go/src/github.com/dotcloud/docker/$(BINDDIR)")
@ -59,6 +60,7 @@ docs-build:
cp ./VERSION docs/VERSION cp ./VERSION docs/VERSION
echo "$(GIT_BRANCH)" > docs/GIT_BRANCH echo "$(GIT_BRANCH)" > docs/GIT_BRANCH
echo "$(AWS_S3_BUCKET)" > docs/AWS_S3_BUCKET echo "$(AWS_S3_BUCKET)" > docs/AWS_S3_BUCKET
echo "$(GITCOMMIT)" > docs/GITCOMMIT
docker build -t "$(DOCKER_DOCS_IMAGE)" docs docker build -t "$(DOCKER_DOCS_IMAGE)" docs
bundles: bundles:

6
docs/Dockerfile
View File

@ -28,8 +28,12 @@ WORKDIR /docs
RUN VERSION=$(cat /docs/VERSION) &&\ RUN VERSION=$(cat /docs/VERSION) &&\
GIT_BRANCH=$(cat /docs/GIT_BRANCH) &&\ GIT_BRANCH=$(cat /docs/GIT_BRANCH) &&\
GITCOMMIT=$(cat /docs/GITCOMMIT) &&\
AWS_S3_BUCKET=$(cat /docs/AWS_S3_BUCKET) &&\ AWS_S3_BUCKET=$(cat /docs/AWS_S3_BUCKET) &&\
echo "{% set docker_version = \"${VERSION}\" %}{% set docker_branch = \"${GIT_BRANCH}\" %}{% set aws_bucket = \"${AWS_S3_BUCKET}\" %}{% include \"beta_warning.html\" %}" > /docs/theme/mkdocs/version.html sed -i "s/\$VERSION/$VERSION/g" /docs/theme/mkdocs/base.html &&\
sed -i "s/\$GITCOMMIT/$GITCOMMIT/g" /docs/theme/mkdocs/base.html &&\
sed -i "s/\$GIT_BRANCH/$GIT_BRANCH/g" /docs/theme/mkdocs/base.html &&\
sed -i "s/\$AWS_S3_BUCKET/$AWS_S3_BUCKET/g" /docs/theme/mkdocs/base.html
# note, EXPOSE is only last because of https://github.com/dotcloud/docker/issues/3525 # note, EXPOSE is only last because of https://github.com/dotcloud/docker/issues/3525
EXPOSE 8000 EXPOSE 8000

24
docs/release.sh
View File

@ -18,7 +18,15 @@ EOF
[ "$AWS_S3_BUCKET" ] || usage [ "$AWS_S3_BUCKET" ] || usage
#VERSION=$(cat VERSION) VERSION=$(cat VERSION)
if [ "$$AWS_S3_BUCKET" == "docs.docker.com" ]; then
if [ "${VERSION%-dev}" != "$VERSION" ]; then
echo "Please do not push '-dev' documentation to docs.docker.com ($VERSION)"
exit 1
fi
fi
export BUCKET=$AWS_S3_BUCKET export BUCKET=$AWS_S3_BUCKET
export AWS_CONFIG_FILE=$(pwd)/awsconfig export AWS_CONFIG_FILE=$(pwd)/awsconfig
@ -50,7 +58,7 @@ build_current_documentation() {
upload_current_documentation() { upload_current_documentation() {
src=site/ src=site/
dst=s3://$BUCKET dst=s3://$BUCKET$1
echo echo
echo "Uploading $src" echo "Uploading $src"
@ -61,7 +69,7 @@ upload_current_documentation() {
# a really complicated way to send only the files we want # a really complicated way to send only the files we want
# if there are too many in any one set, aws s3 sync seems to fall over with 2 files to go # if there are too many in any one set, aws s3 sync seems to fall over with 2 files to go
endings=( json html xml css js gif png JPG ) endings=( json html xml css js gif png JPG ttf svg woff)
for i in ${endings[@]}; do for i in ${endings[@]}; do
include="" include=""
for j in ${endings[@]}; do for j in ${endings[@]}; do
@ -78,11 +86,8 @@ upload_current_documentation() {
--exclude *.DS_Store \ --exclude *.DS_Store \
--exclude *.psd \ --exclude *.psd \
--exclude *.ai \ --exclude *.ai \
--exclude *.svg \
--exclude *.eot \ --exclude *.eot \
--exclude *.otf \ --exclude *.otf \
--exclude *.ttf \
--exclude *.woff \
--exclude *.rej \ --exclude *.rej \
--exclude *.rst \ --exclude *.rst \
--exclude *.orig \ --exclude *.orig \
@ -99,3 +104,10 @@ setup_s3
build_current_documentation build_current_documentation
upload_current_documentation upload_current_documentation
# Remove the last version - 1.0.2-dev -> 1.0
MAJOR_MINOR="v${VERSION%.*}"
#build again with /v1.0/ prefix
sed -i "s/^site_url:.*/site_url: \/$MAJOR_MINOR\//" mkdocs.yml
build_current_documentation
upload_current_documentation "/$MAJOR_MINOR/"

8
docs/theme/mkdocs/base.html vendored
View File

@ -3,6 +3,12 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
{% set docker_version = "$VERSION" %}{% set docker_commit = "$GITCOMMIT" %}{% set docker_branch = "$GIT_BRANCH" %}{% set aws_bucket = "$AWS_S3_BUCKET" %}
<meta name="docker_version" content="{{ docker_version }}">
<meta name="docker_git_branch" content="{{ docker_branch }}">
<meta name="docker_git_commit" content="{{ docker_commit }}">
{% if meta.page_description %}<meta name="description" content="{{ meta.page_description[0] }}">{% endif %} {% if meta.page_description %}<meta name="description" content="{{ meta.page_description[0] }}">{% endif %}
{% if meta.page_keywords %}<meta name="keywords" content="{{ meta.page_keywords[0] }}">{% endif %} {% if meta.page_keywords %}<meta name="keywords" content="{{ meta.page_keywords[0] }}">{% endif %}
{% if site_author %}<meta name="author" content="{{ site_author }}">{% endif %} {% if site_author %}<meta name="author" content="{{ site_author }}">{% endif %}
@ -59,7 +65,7 @@
</div> </div>
</div> </div>
<div class="span9 content-body"> <div class="span9 content-body">
{% include "version.html" %} {% include "beta_warning.html" %}
{{ content }} {{ content }}
</div> </div>
</div> </div>