diff --git a/Makefile b/Makefile index aee240acee..00237e0fc7 100644 --- a/Makefile +++ b/Makefile @@ -23,11 +23,6 @@ DOCKER_ENVS := \ BIND_DIR := $(if $(BINDDIR),$(BINDDIR),$(if $(DOCKER_HOST),,bundles)) DOCKER_MOUNT := $(if $(BIND_DIR),-v "$(CURDIR)/$(BIND_DIR):/go/src/github.com/docker/docker/$(BIND_DIR)") -# to allow `make DOCSDIR=docs docs-shell` (to create a bind mount in docs) -DOCS_MOUNT := $(if $(DOCSDIR),-v $(CURDIR)/$(DOCSDIR):/$(DOCSDIR)) - -# to allow `make DOCSPORT=9000 docs` -DOCSPORT := 8000 GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null) DOCKER_IMAGE := docker-dev$(if $(GIT_BRANCH),:$(GIT_BRANCH)) @@ -51,19 +46,6 @@ binary: build cross: build $(DOCKER_RUN_DOCKER) hack/make.sh binary cross -docs: docs-build - $(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 "$(DOCKER_DOCS_IMAGE)" mkdocs serve - -docs-shell: docs-build - $(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 "$(DOCKER_DOCS_IMAGE)" bash - -docs-release: docs-build - $(DOCKER_RUN_DOCS) -e OPTIONS -e BUILD_ROOT -e DISTRIBUTION_ID \ - -v $(CURDIR)/docs/awsconfig:/docs/awsconfig \ - "$(DOCKER_DOCS_IMAGE)" ./release.sh - -docs-test: docs-build - $(DOCKER_RUN_DOCS) "$(DOCKER_DOCS_IMAGE)" ./test.sh test: build $(DOCKER_RUN_DOCKER) hack/make.sh binary cross test-unit test-integration-cli test-docker-py @@ -86,13 +68,5 @@ shell: build build: bundles docker build -t "$(DOCKER_IMAGE)" . -docs-build: - cp ./VERSION docs/VERSION - echo "$(GIT_BRANCH)" > docs/GIT_BRANCH -# echo "$(AWS_S3_BUCKET)" > docs/AWS_S3_BUCKET - echo "$(GITCOMMIT)" > docs/GITCOMMIT - docker pull docs/base - docker build -t "$(DOCKER_DOCS_IMAGE)" docs - bundles: mkdir bundles diff --git a/docs/Dockerfile b/docs/Dockerfile index bda3ccd9e9..02e0553eb7 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -1,163 +1,24 @@ -# -# See the top level Makefile in https://github.com/docker/docker for usage. -# -FROM docs/base:latest -MAINTAINER Sven Dowideit (@SvenDowideit) +FROM docs/base:hugo +MAINTAINER Mary Anthony (@moxiegirl) -# This section ensures we pull the correct version of each -# sub project -ENV COMPOSE_BRANCH release -ENV SWARM_BRANCH v0.2.0 -ENV MACHINE_BRANCH docs -ENV DISTRIB_BRANCH docs -ENV KITEMATIC_BRANCH master - - -# TODO: need the full repo source to get the git version info +# 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 +COPY . /docs/content/engine/ -# Then copy the desired docs into the /docs/sources/ dir -COPY ./sources/ /docs/sources - -COPY ./VERSION VERSION - -# adding the image spec will require Docker 1.5 and `docker build -f docs/Dockerfile .` -#COPY ./image/spec/v1.md /docs/sources/reference/image-spec-v1.md - -# TODO: don't do this - look at merging the yml file in build.sh -COPY ./mkdocs.yml ./s3_website.json ./release.sh ./ - -####################### -# Docker Distribution -######################## - -#ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/mkdocs.yml /docs/mkdocs-distribution.yml - -ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/images/notifications.png \ - https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/images/registry.png \ - /docs/sources/registry/images/ - -ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/index.md \ - https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/deploying.md \ - https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/configuration.md \ - https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/storagedrivers.md \ - https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/notifications.md \ - /docs/sources/registry/ - -ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/spec/api.md \ - https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/spec/json.md \ - /docs/sources/registry/spec/ - -ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/storage-drivers/s3.md \ - https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/storage-drivers/azure.md \ - https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/storage-drivers/filesystem.md \ - https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/storage-drivers/inmemory.md \ - /docs/sources/registry/storage-drivers/ - -ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/spec/auth/token.md /docs/sources/registry/spec/auth/token.md - -RUN sed -i.old '1s;^;no_version_dropdown: true;' \ - /docs/sources/registry/*.md \ - /docs/sources/registry/spec/*.md \ - /docs/sources/registry/spec/auth/*.md \ - /docs/sources/registry/storage-drivers/*.md - -RUN sed -i.old -e '/^/g'\ - /docs/sources/registry/*.md \ - /docs/sources/registry/spec/*.md \ - /docs/sources/registry/spec/auth/*.md \ - /docs/sources/registry/storage-drivers/*.md - -####################### -# Docker Swarm -####################### - -#ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/docs/mkdocs.yml /docs/mkdocs-swarm.yml -ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/docs/index.md /docs/sources/swarm/index.md - -ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/discovery/README.md /docs/sources/swarm/discovery.md - -ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/api/README.md /docs/sources/swarm/API.md - -ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/scheduler/filter/README.md /docs/sources/swarm/scheduler/filter.md - -ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/scheduler/strategy/README.md /docs/sources/swarm/scheduler/strategy.md - -RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/swarm/*.md /docs/sources/swarm/scheduler/*.md - -####################### -# Docker Machine -####################### -#ADD https://raw.githubusercontent.com/docker/machine/${MACHINE_BRANCH}/docs/mkdocs.yml /docs/mkdocs-machine.yml - -ADD https://raw.githubusercontent.com/docker/machine/${MACHINE_BRANCH}/docs/index.md /docs/sources/machine/index.md -RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/machine/index.md - -####################### -# Docker Compose -####################### - -#ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/mkdocs.yml /docs/mkdocs-compose.yml - -ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/index.md \ - https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/install.md \ - https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/cli.md \ - https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/yml.md \ - https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/env.md \ - https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/completion.md \ - https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/django.md \ - https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/rails.md \ - https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/wordpress.md \ - https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/extends.md \ - https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/production.md \ - /docs/sources/compose/ - -RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/*.md - -####################### -# Kitematic -####################### -ADD https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/faq.md \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/index.md \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/known-issues.md \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/minecraft-server.md \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/nginx-web-server.md \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/rethinkdb-dev-database.md \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/userguide.md \ - /docs/sources/kitematic/ -RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/kitematic/*.md -ADD https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/browse-images.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/change-folder.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/cli-access-button.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/cli-redis-container.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/cli-terminal.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/containers.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/installing.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-add-server.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-create.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-data-volume.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-login.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-map.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-port.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-restart.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-server-address.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-2048-files.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-2048.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-create.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-data-folder.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-data-volume.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-hello-world.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-preview.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-serving-2048.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/rethink-container.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/rethink-create.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/rethink-ports.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/rethinkdb-preview.png \ - https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/volumes-dir.png \ - /docs/sources/kitematic/assets/ - -# Then build everything together, ready for mkdocs -RUN /docs/build.sh +# 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) +# +# +RUN find /docs/content/engine -type f -name "*.md" -exec sed -i.old \ + -e '/^/g' \ + -e '/^/g' \ + -e 's/\([(]\)\(.*\)\(\.md\)/\1\2/g' \ + -e 's/\(\]\)\([(]\)\(\/\)/\1\2\/engine\//g' \ + -e 's/\(\][(]\)\([A-z]*[)]\)/\]\(\/engine\/\2/g' \ + -e 's/\(\][(]\)\(\.\.\/\)/\1\/engine\//g' {} \; diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000000..021e8f6e5e --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,55 @@ +.PHONY: all binary build cross default docs docs-build docs-shell shell test test-unit test-integration test-integration-cli test-docker-py validate + +# env vars passed through directly to Docker's build scripts +# to allow things like `make DOCKER_CLIENTONLY=1 binary` easily +# `docs/sources/contributing/devenvironment.md ` and `project/PACKAGERS.md` have some limited documentation of some of these +DOCKER_ENVS := \ + -e BUILDFLAGS \ + -e DOCKER_CLIENTONLY \ + -e DOCKER_EXECDRIVER \ + -e DOCKER_GRAPHDRIVER \ + -e TESTDIRS \ + -e TESTFLAGS \ + -e TIMEOUT +# note: we _cannot_ add "-e DOCKER_BUILDTAGS" here because even if it's unset in the shell, that would shadow the "ENV DOCKER_BUILDTAGS" set in our Dockerfile, which is very important for our official builds + +# to allow `make DOCSDIR=docs docs-shell` (to create a bind mount in docs) +DOCS_MOUNT := $(if $(DOCSDIR),-v $(CURDIR)/$(DOCSDIR):/$(DOCSDIR)) + +# to allow `make DOCSPORT=9000 docs` +DOCSPORT := 8000 + +# Get the IP ADDRESS +DOCKER_IP=$(shell python -c "import urlparse ; print urlparse.urlparse('$(DOCKER_HOST)').hostname or ''") +HUGO_BASE_URL=$(shell test -z "$(DOCKER_IP)" && echo localhost || echo "$(DOCKER_IP)") +HUGO_BIND_IP=0.0.0.0 + +GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null) +DOCKER_IMAGE := docker$(if $(GIT_BRANCH),:$(GIT_BRANCH)) +DOCKER_DOCS_IMAGE := docs-base$(if $(GIT_BRANCH),:$(GIT_BRANCH)) + + +DOCKER_RUN_DOCS := docker run --rm -it $(DOCS_MOUNT) -e AWS_S3_BUCKET -e NOCACHE + +# for some docs workarounds (see below in "docs-build" target) +GITCOMMIT := $(shell git rev-parse --short HEAD 2>/dev/null) + +default: docs + +docs: docs-build + $(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)" hugo server --port=$(DOCSPORT) --baseUrl=$(HUGO_BASE_URL) --bind=$(HUGO_BIND_IP) + +docs-draft: docs-build + $(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)" hugo server --buildDrafts="true" --port=$(DOCSPORT) --baseUrl=$(HUGO_BASE_URL) --bind=$(HUGO_BIND_IP) + + +docs-shell: docs-build + $(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 "$(DOCKER_DOCS_IMAGE)" bash + + +docs-build: +# ( git remote | grep -v upstream ) || git diff --name-status upstream/release..upstream/docs ./ > ./changed-files +# echo "$(GIT_BRANCH)" > GIT_BRANCH +# echo "$(AWS_S3_BUCKET)" > AWS_S3_BUCKET +# echo "$(GITCOMMIT)" > GITCOMMIT + docker build -t "$(DOCKER_DOCS_IMAGE)" . diff --git a/docs/README.md b/docs/README.md index f22ae49efa..b8d50c8d91 100755 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,9 @@ + + # Docker Documentation The source for Docker documentation is in this directory under `sources/`. Our diff --git a/docs/sources/article-img/architecture.svg b/docs/article-img/architecture.svg similarity index 100% rename from docs/sources/article-img/architecture.svg rename to docs/article-img/architecture.svg diff --git a/docs/sources/article-img/ipv6_basic_host_config.gliffy b/docs/article-img/ipv6_basic_host_config.gliffy similarity index 100% rename from docs/sources/article-img/ipv6_basic_host_config.gliffy rename to docs/article-img/ipv6_basic_host_config.gliffy diff --git a/docs/sources/article-img/ipv6_basic_host_config.svg b/docs/article-img/ipv6_basic_host_config.svg similarity index 100% rename from docs/sources/article-img/ipv6_basic_host_config.svg rename to docs/article-img/ipv6_basic_host_config.svg diff --git a/docs/sources/article-img/ipv6_ndp_proxying.gliffy b/docs/article-img/ipv6_ndp_proxying.gliffy similarity index 100% rename from docs/sources/article-img/ipv6_ndp_proxying.gliffy rename to docs/article-img/ipv6_ndp_proxying.gliffy diff --git a/docs/sources/article-img/ipv6_ndp_proxying.svg b/docs/article-img/ipv6_ndp_proxying.svg similarity index 100% rename from docs/sources/article-img/ipv6_ndp_proxying.svg rename to docs/article-img/ipv6_ndp_proxying.svg diff --git a/docs/sources/article-img/ipv6_routed_network_example.gliffy b/docs/article-img/ipv6_routed_network_example.gliffy similarity index 100% rename from docs/sources/article-img/ipv6_routed_network_example.gliffy rename to docs/article-img/ipv6_routed_network_example.gliffy diff --git a/docs/sources/article-img/ipv6_routed_network_example.svg b/docs/article-img/ipv6_routed_network_example.svg similarity index 100% rename from docs/sources/article-img/ipv6_routed_network_example.svg rename to docs/article-img/ipv6_routed_network_example.svg diff --git a/docs/sources/article-img/ipv6_slash64_subnet_config.gliffy b/docs/article-img/ipv6_slash64_subnet_config.gliffy similarity index 100% rename from docs/sources/article-img/ipv6_slash64_subnet_config.gliffy rename to docs/article-img/ipv6_slash64_subnet_config.gliffy diff --git a/docs/sources/article-img/ipv6_slash64_subnet_config.svg b/docs/article-img/ipv6_slash64_subnet_config.svg similarity index 100% rename from docs/sources/article-img/ipv6_slash64_subnet_config.svg rename to docs/article-img/ipv6_slash64_subnet_config.svg diff --git a/docs/sources/article-img/ipv6_switched_network_example.gliffy b/docs/article-img/ipv6_switched_network_example.gliffy similarity index 100% rename from docs/sources/article-img/ipv6_switched_network_example.gliffy rename to docs/article-img/ipv6_switched_network_example.gliffy diff --git a/docs/sources/article-img/ipv6_switched_network_example.svg b/docs/article-img/ipv6_switched_network_example.svg similarity index 100% rename from docs/sources/article-img/ipv6_switched_network_example.svg rename to docs/article-img/ipv6_switched_network_example.svg diff --git a/docs/sources/articles/ambassador_pattern_linking.md b/docs/articles/ambassador_pattern_linking.md similarity index 94% rename from docs/sources/articles/ambassador_pattern_linking.md rename to docs/articles/ambassador_pattern_linking.md index 2f168262a3..5a04540302 100644 --- a/docs/sources/articles/ambassador_pattern_linking.md +++ b/docs/articles/ambassador_pattern_linking.md @@ -1,6 +1,13 @@ -page_title: Link via an ambassador container -page_description: Using the Ambassador pattern to abstract (network) services -page_keywords: Examples, Usage, links, docker, documentation, examples, names, name, container naming + # Link via an ambassador container diff --git a/docs/sources/articles/b2d_volume_images/add_cd.png b/docs/articles/b2d_volume_images/add_cd.png similarity index 100% rename from docs/sources/articles/b2d_volume_images/add_cd.png rename to docs/articles/b2d_volume_images/add_cd.png diff --git a/docs/sources/articles/b2d_volume_images/add_new_controller.png b/docs/articles/b2d_volume_images/add_new_controller.png similarity index 100% rename from docs/sources/articles/b2d_volume_images/add_new_controller.png rename to docs/articles/b2d_volume_images/add_new_controller.png diff --git a/docs/sources/articles/b2d_volume_images/add_volume.png b/docs/articles/b2d_volume_images/add_volume.png similarity index 100% rename from docs/sources/articles/b2d_volume_images/add_volume.png rename to docs/articles/b2d_volume_images/add_volume.png diff --git a/docs/sources/articles/b2d_volume_images/boot_order.png b/docs/articles/b2d_volume_images/boot_order.png similarity index 100% rename from docs/sources/articles/b2d_volume_images/boot_order.png rename to docs/articles/b2d_volume_images/boot_order.png diff --git a/docs/sources/articles/b2d_volume_images/gparted.png b/docs/articles/b2d_volume_images/gparted.png similarity index 100% rename from docs/sources/articles/b2d_volume_images/gparted.png rename to docs/articles/b2d_volume_images/gparted.png diff --git a/docs/sources/articles/b2d_volume_images/gparted2.png b/docs/articles/b2d_volume_images/gparted2.png similarity index 100% rename from docs/sources/articles/b2d_volume_images/gparted2.png rename to docs/articles/b2d_volume_images/gparted2.png diff --git a/docs/sources/articles/b2d_volume_images/verify.png b/docs/articles/b2d_volume_images/verify.png similarity index 100% rename from docs/sources/articles/b2d_volume_images/verify.png rename to docs/articles/b2d_volume_images/verify.png diff --git a/docs/sources/articles/b2d_volume_resize.md b/docs/articles/b2d_volume_resize.md similarity index 93% rename from docs/sources/articles/b2d_volume_resize.md rename to docs/articles/b2d_volume_resize.md index 53c8590955..34884613ff 100644 --- a/docs/sources/articles/b2d_volume_resize.md +++ b/docs/articles/b2d_volume_resize.md @@ -1,6 +1,12 @@ -page_title: Resizing a Boot2Docker volume -page_description: Resizing a Boot2Docker volume in VirtualBox with GParted -page_keywords: boot2docker, volume, virtualbox + # Getting “no space left on device” errors with Boot2Docker? diff --git a/docs/sources/articles/baseimages.md b/docs/articles/baseimages.md similarity index 92% rename from docs/sources/articles/baseimages.md rename to docs/articles/baseimages.md index 325ad3f7bc..b3875aa55e 100644 --- a/docs/sources/articles/baseimages.md +++ b/docs/articles/baseimages.md @@ -1,6 +1,12 @@ -page_title: Create a base image -page_description: How to create base images -page_keywords: Examples, Usage, base image, docker, documentation, examples + # Create a base image diff --git a/docs/sources/articles/basics.md b/docs/articles/basics.md similarity index 95% rename from docs/sources/articles/basics.md rename to docs/articles/basics.md index f1c2be9596..948fa7bd14 100644 --- a/docs/sources/articles/basics.md +++ b/docs/articles/basics.md @@ -1,8 +1,14 @@ -page_title: First steps with Docker -page_description: Common usage and commands -page_keywords: Examples, Usage, basic commands, docker, documentation, examples + -# First steps with Docker +# "Get started with containers This guide assumes you have a working installation of Docker. To verify Docker is installed, use the following command: diff --git a/docs/sources/articles/certificates.md b/docs/articles/certificates.md similarity index 91% rename from docs/sources/articles/certificates.md rename to docs/articles/certificates.md index 9c6e00fcb9..366c020d02 100644 --- a/docs/sources/articles/certificates.md +++ b/docs/articles/certificates.md @@ -1,6 +1,12 @@ -page_title: Using certificates for repository client verification -page_description: How to set up and use certificates with a registry to verify access -page_keywords: Usage, registry, repository, client, root, certificate, docker, apache, ssl, tls, documentation, examples, articles, tutorials + # Using certificates for repository client verification diff --git a/docs/sources/articles/cfengine_process_management.md b/docs/articles/cfengine_process_management.md similarity index 95% rename from docs/sources/articles/cfengine_process_management.md rename to docs/articles/cfengine_process_management.md index b0437268b0..b2e5737307 100644 --- a/docs/sources/articles/cfengine_process_management.md +++ b/docs/articles/cfengine_process_management.md @@ -1,6 +1,12 @@ -page_title: Process management with CFEngine -page_description: Managing containerized processes with CFEngine -page_keywords: cfengine, process, management, usage, docker, documentation + # Process management with CFEngine diff --git a/docs/sources/articles/chef.md b/docs/articles/chef.md similarity index 89% rename from docs/sources/articles/chef.md rename to docs/articles/chef.md index 84ccdffb2b..6a30ccb781 100644 --- a/docs/sources/articles/chef.md +++ b/docs/articles/chef.md @@ -1,6 +1,12 @@ -page_title: Using Chef -page_description: Installation and using Docker via Chef -page_keywords: chef, installation, usage, docker, documentation + # Using Chef diff --git a/docs/sources/articles/configuring.md b/docs/articles/configuring.md similarity index 96% rename from docs/sources/articles/configuring.md rename to docs/articles/configuring.md index 7bd92417cd..3321573d05 100644 --- a/docs/sources/articles/configuring.md +++ b/docs/articles/configuring.md @@ -1,6 +1,13 @@ -page_title: Configuring and running Docker -page_description: Configuring and running the Docker daemon on various distributions -page_keywords: docker, daemon, configuration, running, process managers + # Configuring and running Docker on various distributions diff --git a/docs/sources/articles/dockerfile_best-practices.md b/docs/articles/dockerfile_best-practices.md similarity index 98% rename from docs/sources/articles/dockerfile_best-practices.md rename to docs/articles/dockerfile_best-practices.md index 8c9c6ed515..4c365a4573 100644 --- a/docs/sources/articles/dockerfile_best-practices.md +++ b/docs/articles/dockerfile_best-practices.md @@ -1,6 +1,12 @@ -page_title: Best practices for writing Dockerfiles -page_description: Hints, tips and guidelines for writing clean, reliable Dockerfiles -page_keywords: Examples, Usage, base image, docker, documentation, dockerfile, best practices, hub, official repo + # Best practices for writing Dockerfiles diff --git a/docs/sources/articles/dsc.md b/docs/articles/dsc.md similarity index 95% rename from docs/sources/articles/dsc.md rename to docs/articles/dsc.md index 18cbc0a8e9..b6497baf0d 100644 --- a/docs/sources/articles/dsc.md +++ b/docs/articles/dsc.md @@ -1,6 +1,12 @@ -page_title: PowerShell DSC Usage -page_description: Using DSC to configure a new Docker host -page_keywords: powershell, dsc, installation, usage, docker, documentation + # Using PowerShell DSC diff --git a/docs/sources/articles/host_integration.md b/docs/articles/host_integration.md similarity index 90% rename from docs/sources/articles/host_integration.md rename to docs/articles/host_integration.md index e3451764bb..5317096197 100644 --- a/docs/sources/articles/host_integration.md +++ b/docs/articles/host_integration.md @@ -1,6 +1,13 @@ -page_title: Automatically start containers -page_description: How to generate scripts for upstart, systemd, etc. -page_keywords: systemd, upstart, supervisor, docker, documentation, host integration + # Automatically start containers diff --git a/docs/sources/articles/https.md b/docs/articles/https.md similarity index 96% rename from docs/sources/articles/https.md rename to docs/articles/https.md index 6a237eb3d5..7fe1d88c1b 100644 --- a/docs/sources/articles/https.md +++ b/docs/articles/https.md @@ -1,8 +1,15 @@ -page_title: Protecting the Docker daemon socket with HTTPS -page_description: How to setup and run Docker with HTTPS -page_keywords: docker, docs, article, example, https, daemon, tls, ca, certificate + -# Protecting the Docker daemon socket with HTTPS +# Protect the Docker daemon socket By default, Docker runs via a non-networked Unix socket. It can also optionally communicate using a HTTP socket. diff --git a/docs/sources/articles/https/Dockerfile b/docs/articles/https/Dockerfile similarity index 100% rename from docs/sources/articles/https/Dockerfile rename to docs/articles/https/Dockerfile diff --git a/docs/sources/articles/https/Makefile b/docs/articles/https/Makefile similarity index 100% rename from docs/sources/articles/https/Makefile rename to docs/articles/https/Makefile diff --git a/docs/sources/articles/https/README.md b/docs/articles/https/README.md similarity index 100% rename from docs/sources/articles/https/README.md rename to docs/articles/https/README.md diff --git a/docs/sources/articles/https/make_certs.sh b/docs/articles/https/make_certs.sh similarity index 100% rename from docs/sources/articles/https/make_certs.sh rename to docs/articles/https/make_certs.sh diff --git a/docs/sources/articles/https/parsedocs.sh b/docs/articles/https/parsedocs.sh similarity index 100% rename from docs/sources/articles/https/parsedocs.sh rename to docs/articles/https/parsedocs.sh diff --git a/docs/sources/articles/networking.md b/docs/articles/networking.md similarity index 99% rename from docs/sources/articles/networking.md rename to docs/articles/networking.md index 75c3c7d461..d454dc1fd9 100644 --- a/docs/sources/articles/networking.md +++ b/docs/articles/networking.md @@ -1,10 +1,16 @@ -page_title: Network configuration -page_description: Docker networking -page_keywords: network, networking, bridge, docker, documentation + # Network configuration -## TL;DR +## Summary When Docker starts, it creates a virtual interface named `docker0` on the host machine. It randomly chooses an address and subnet from the diff --git a/docs/sources/articles/puppet.md b/docs/articles/puppet.md similarity index 92% rename from docs/sources/articles/puppet.md rename to docs/articles/puppet.md index a1b3d273a4..34f3712ddc 100644 --- a/docs/sources/articles/puppet.md +++ b/docs/articles/puppet.md @@ -1,6 +1,12 @@ -page_title: Using Puppet -page_description: Installing and using Puppet -page_keywords: puppet, installation, usage, docker, documentation + # Using Puppet diff --git a/docs/sources/articles/registry_mirror.md b/docs/articles/registry_mirror.md similarity index 91% rename from docs/sources/articles/registry_mirror.md rename to docs/articles/registry_mirror.md index e928af12af..0a2d4f4ea4 100644 --- a/docs/sources/articles/registry_mirror.md +++ b/docs/articles/registry_mirror.md @@ -1,6 +1,12 @@ -page_title: Run a local registry mirror -page_description: How to set up and run a local registry mirror -page_keywords: docker, registry, mirror, examples + # Run a local registry mirror diff --git a/docs/sources/articles/runmetrics.md b/docs/articles/runmetrics.md similarity index 98% rename from docs/sources/articles/runmetrics.md rename to docs/articles/runmetrics.md index a887d4369a..669ee40173 100644 --- a/docs/sources/articles/runmetrics.md +++ b/docs/articles/runmetrics.md @@ -1,6 +1,13 @@ -page_title: Runtime metrics -page_description: Measure the behavior of running containers -page_keywords: docker, metrics, CPU, memory, disk, IO, run, runtime + # Runtime metrics diff --git a/docs/sources/articles/security.md b/docs/articles/security.md similarity index 98% rename from docs/sources/articles/security.md rename to docs/articles/security.md index 995a7ce124..9f21b0b61a 100644 --- a/docs/sources/articles/security.md +++ b/docs/articles/security.md @@ -1,6 +1,13 @@ -page_title: Docker security -page_description: Review of the Docker Daemon attack surface -page_keywords: Docker, Docker documentation, security + # Docker security diff --git a/docs/sources/articles/systemd.md b/docs/articles/systemd.md similarity index 92% rename from docs/sources/articles/systemd.md rename to docs/articles/systemd.md index 02832ff542..919ad50daa 100644 --- a/docs/sources/articles/systemd.md +++ b/docs/articles/systemd.md @@ -1,8 +1,15 @@ -page_title: Controlling and configuring Docker using systemd -page_description: Controlling and configuring Docker using systemd -page_keywords: docker, daemon, systemd, configuration + -# Controlling and configuring Docker using systemd +# Control and configure Docker with systemd Many Linux distributions use systemd to start the Docker daemon. This document shows a few examples of how to customise Docker's settings. diff --git a/docs/sources/articles/using_supervisord.md b/docs/articles/using_supervisord.md similarity index 94% rename from docs/sources/articles/using_supervisord.md rename to docs/articles/using_supervisord.md index 0c5557091a..931f38c1c4 100644 --- a/docs/sources/articles/using_supervisord.md +++ b/docs/articles/using_supervisord.md @@ -1,6 +1,12 @@ -page_title: Using Supervisor with Docker -page_description: How to use Supervisor process management with Docker -page_keywords: docker, supervisor, process management + # Using Supervisor with Docker diff --git a/docs/sources/docker-hub/accounts.md b/docs/docker-hub/accounts.md similarity index 92% rename from docs/sources/docker-hub/accounts.md rename to docs/docker-hub/accounts.md index 510111f8ef..d2f20c971d 100644 --- a/docs/sources/docker-hub/accounts.md +++ b/docs/docker-hub/accounts.md @@ -1,6 +1,12 @@ -page_title: Accounts on Docker Hub -page_description: Docker Hub accounts -page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, documentation + # Accounts on Docker Hub diff --git a/docs/sources/docker-hub/builds.md b/docs/docker-hub/builds.md similarity index 98% rename from docs/sources/docker-hub/builds.md rename to docs/docker-hub/builds.md index 7173a175be..34c5e9c657 100644 --- a/docs/sources/docker-hub/builds.md +++ b/docs/docker-hub/builds.md @@ -1,6 +1,12 @@ -page_title: Automated Builds on Docker Hub -page_description: Docker Hub Automated Builds -page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, documentation, trusted, builds, trusted builds, automated builds + # Automated Builds on Docker Hub diff --git a/docs/sources/docker-hub/home.md b/docs/docker-hub/home.md similarity index 51% rename from docs/sources/docker-hub/home.md rename to docs/docker-hub/home.md index 3f81208c19..251335a4ad 100644 --- a/docs/sources/docker-hub/home.md +++ b/docs/docker-hub/home.md @@ -1,6 +1,12 @@ -page_title: The Docker Hub Registry help -page_description: The Docker Registry help documentation home -page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, documentation + # The Docker Hub Registry help diff --git a/docs/sources/docker-hub/hub-images/bb_hooks.png b/docs/docker-hub/hub-images/bb_hooks.png similarity index 100% rename from docs/sources/docker-hub/hub-images/bb_hooks.png rename to docs/docker-hub/hub-images/bb_hooks.png diff --git a/docs/sources/docker-hub/hub-images/bb_menu.png b/docs/docker-hub/hub-images/bb_menu.png similarity index 100% rename from docs/sources/docker-hub/hub-images/bb_menu.png rename to docs/docker-hub/hub-images/bb_menu.png diff --git a/docs/sources/docker-hub/hub-images/bb_post-hook.png b/docs/docker-hub/hub-images/bb_post-hook.png similarity index 100% rename from docs/sources/docker-hub/hub-images/bb_post-hook.png rename to docs/docker-hub/hub-images/bb_post-hook.png diff --git a/docs/sources/docker-hub/hub-images/build-trigger.png b/docs/docker-hub/hub-images/build-trigger.png similarity index 100% rename from docs/sources/docker-hub/hub-images/build-trigger.png rename to docs/docker-hub/hub-images/build-trigger.png diff --git a/docs/sources/docker-hub/hub-images/dashboard.png b/docs/docker-hub/hub-images/dashboard.png similarity index 100% rename from docs/sources/docker-hub/hub-images/dashboard.png rename to docs/docker-hub/hub-images/dashboard.png diff --git a/docs/sources/docker-hub/hub-images/deploy_key.png b/docs/docker-hub/hub-images/deploy_key.png similarity index 100% rename from docs/sources/docker-hub/hub-images/deploy_key.png rename to docs/docker-hub/hub-images/deploy_key.png diff --git a/docs/sources/docker-hub/hub-images/gh-check-admin-org-dh-app-access.png b/docs/docker-hub/hub-images/gh-check-admin-org-dh-app-access.png similarity index 100% rename from docs/sources/docker-hub/hub-images/gh-check-admin-org-dh-app-access.png rename to docs/docker-hub/hub-images/gh-check-admin-org-dh-app-access.png diff --git a/docs/sources/docker-hub/hub-images/gh-check-user-org-dh-app-access.png b/docs/docker-hub/hub-images/gh-check-user-org-dh-app-access.png similarity index 100% rename from docs/sources/docker-hub/hub-images/gh-check-user-org-dh-app-access.png rename to docs/docker-hub/hub-images/gh-check-user-org-dh-app-access.png diff --git a/docs/sources/docker-hub/hub-images/gh_add_ssh_user_key.png b/docs/docker-hub/hub-images/gh_add_ssh_user_key.png similarity index 100% rename from docs/sources/docker-hub/hub-images/gh_add_ssh_user_key.png rename to docs/docker-hub/hub-images/gh_add_ssh_user_key.png diff --git a/docs/sources/docker-hub/hub-images/gh_docker-service.png b/docs/docker-hub/hub-images/gh_docker-service.png similarity index 100% rename from docs/sources/docker-hub/hub-images/gh_docker-service.png rename to docs/docker-hub/hub-images/gh_docker-service.png diff --git a/docs/sources/docker-hub/hub-images/gh_menu.png b/docs/docker-hub/hub-images/gh_menu.png similarity index 100% rename from docs/sources/docker-hub/hub-images/gh_menu.png rename to docs/docker-hub/hub-images/gh_menu.png diff --git a/docs/sources/docker-hub/hub-images/gh_org_members.png b/docs/docker-hub/hub-images/gh_org_members.png similarity index 100% rename from docs/sources/docker-hub/hub-images/gh_org_members.png rename to docs/docker-hub/hub-images/gh_org_members.png diff --git a/docs/sources/docker-hub/hub-images/gh_repo_deploy_key.png b/docs/docker-hub/hub-images/gh_repo_deploy_key.png similarity index 100% rename from docs/sources/docker-hub/hub-images/gh_repo_deploy_key.png rename to docs/docker-hub/hub-images/gh_repo_deploy_key.png diff --git a/docs/sources/docker-hub/hub-images/gh_service_hook.png b/docs/docker-hub/hub-images/gh_service_hook.png similarity index 100% rename from docs/sources/docker-hub/hub-images/gh_service_hook.png rename to docs/docker-hub/hub-images/gh_service_hook.png diff --git a/docs/sources/docker-hub/hub-images/gh_settings.png b/docs/docker-hub/hub-images/gh_settings.png similarity index 100% rename from docs/sources/docker-hub/hub-images/gh_settings.png rename to docs/docker-hub/hub-images/gh_settings.png diff --git a/docs/sources/docker-hub/hub-images/gh_team_members.png b/docs/docker-hub/hub-images/gh_team_members.png similarity index 100% rename from docs/sources/docker-hub/hub-images/gh_team_members.png rename to docs/docker-hub/hub-images/gh_team_members.png diff --git a/docs/sources/docker-hub/hub-images/groups.png b/docs/docker-hub/hub-images/groups.png similarity index 100% rename from docs/sources/docker-hub/hub-images/groups.png rename to docs/docker-hub/hub-images/groups.png diff --git a/docs/sources/docker-hub/hub-images/hub.png b/docs/docker-hub/hub-images/hub.png similarity index 100% rename from docs/sources/docker-hub/hub-images/hub.png rename to docs/docker-hub/hub-images/hub.png diff --git a/docs/sources/docker-hub/hub-images/invite.png b/docs/docker-hub/hub-images/invite.png similarity index 100% rename from docs/sources/docker-hub/hub-images/invite.png rename to docs/docker-hub/hub-images/invite.png diff --git a/docs/sources/docker-hub/hub-images/org-repo-collaborators.png b/docs/docker-hub/hub-images/org-repo-collaborators.png similarity index 100% rename from docs/sources/docker-hub/hub-images/org-repo-collaborators.png rename to docs/docker-hub/hub-images/org-repo-collaborators.png diff --git a/docs/sources/docker-hub/hub-images/orgs.png b/docs/docker-hub/hub-images/orgs.png similarity index 100% rename from docs/sources/docker-hub/hub-images/orgs.png rename to docs/docker-hub/hub-images/orgs.png diff --git a/docs/sources/docker-hub/hub-images/repos.png b/docs/docker-hub/hub-images/repos.png similarity index 100% rename from docs/sources/docker-hub/hub-images/repos.png rename to docs/docker-hub/hub-images/repos.png diff --git a/docs/sources/docker-hub/index.md b/docs/docker-hub/index.md similarity index 73% rename from docs/sources/docker-hub/index.md rename to docs/docker-hub/index.md index db6694d3d5..6520a96436 100644 --- a/docs/sources/docker-hub/index.md +++ b/docs/docker-hub/index.md @@ -1,6 +1,12 @@ -page_title: The Docker Hub help -page_description: The Docker Help documentation home -page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, documentation, accounts, organizations, repositories, groups + # Docker Hub diff --git a/docs/sources/docker-hub/official_repos.md b/docs/docker-hub/official_repos.md similarity index 94% rename from docs/sources/docker-hub/official_repos.md rename to docs/docker-hub/official_repos.md index 7ca8ba2f42..415e00c9c0 100644 --- a/docs/sources/docker-hub/official_repos.md +++ b/docs/docker-hub/official_repos.md @@ -1,6 +1,12 @@ -page_title: Official Repositories on Docker Hub -page_description: Guidelines for Official Repositories on Docker Hub -page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, official, image, documentation + # Official Repositories on Docker Hub diff --git a/docs/sources/docker-hub/repos.md b/docs/docker-hub/repos.md similarity index 96% rename from docs/sources/docker-hub/repos.md rename to docs/docker-hub/repos.md index 1c4176f481..d9ce722da7 100644 --- a/docs/sources/docker-hub/repos.md +++ b/docs/docker-hub/repos.md @@ -1,6 +1,12 @@ -page_title: Your Repositories on Docker Hub -page_description: Your Repositories on Docker Hub -page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, webhooks, docs, documentation + # Your Hub repositories diff --git a/docs/sources/docker-hub/userguide.md b/docs/docker-hub/userguide.md similarity index 90% rename from docs/sources/docker-hub/userguide.md rename to docs/docker-hub/userguide.md index 7ace5f358b..4a9bb73db7 100644 --- a/docs/sources/docker-hub/userguide.md +++ b/docs/docker-hub/userguide.md @@ -1,6 +1,12 @@ -page_title: Docker Hub user guide -page_description: Docker Hub user guide -page_keywords: Docker, docker, registry, Docker Hub, docs, documentation + # Using the Docker Hub diff --git a/docs/sources/examples/apt-cacher-ng.Dockerfile b/docs/examples/apt-cacher-ng.Dockerfile similarity index 100% rename from docs/sources/examples/apt-cacher-ng.Dockerfile rename to docs/examples/apt-cacher-ng.Dockerfile diff --git a/docs/sources/examples/apt-cacher-ng.md b/docs/examples/apt-cacher-ng.md similarity index 92% rename from docs/sources/examples/apt-cacher-ng.md rename to docs/examples/apt-cacher-ng.md index 57aa669666..20cb977ea1 100644 --- a/docs/sources/examples/apt-cacher-ng.md +++ b/docs/examples/apt-cacher-ng.md @@ -1,6 +1,12 @@ -page_title: Dockerizing an apt-cacher-ng service -page_description: Installing and running an apt-cacher-ng service -page_keywords: docker, example, package installation, networking, debian, ubuntu + # Dockerizing an apt-cacher-ng service diff --git a/docs/sources/examples/couchdb_data_volumes.md b/docs/examples/couchdb_data_volumes.md similarity index 84% rename from docs/sources/examples/couchdb_data_volumes.md rename to docs/examples/couchdb_data_volumes.md index 27bce34a95..707c04c18c 100644 --- a/docs/sources/examples/couchdb_data_volumes.md +++ b/docs/examples/couchdb_data_volumes.md @@ -1,6 +1,12 @@ -page_title: Dockerizing a CouchDB service -page_description: Sharing data between 2 couchdb databases -page_keywords: docker, example, package installation, networking, couchdb, data volumes + # Dockerizing a CouchDB service diff --git a/docs/sources/examples/mongodb.md b/docs/examples/mongodb.md similarity index 93% rename from docs/sources/examples/mongodb.md rename to docs/examples/mongodb.md index b7b423b747..6c0974bbe2 100644 --- a/docs/sources/examples/mongodb.md +++ b/docs/examples/mongodb.md @@ -1,6 +1,12 @@ -page_title: Dockerizing MongoDB -page_description: Creating a Docker image with MongoDB pre-installed using a Dockerfile and sharing the image on Docker Hub -page_keywords: docker, dockerize, dockerizing, article, example, docker.io, platform, package, installation, networking, mongodb, containers, images, image, sharing, dockerfile, build, auto-building, virtualization, framework + # Dockerizing MongoDB diff --git a/docs/sources/examples/mongodb/Dockerfile b/docs/examples/mongodb/Dockerfile similarity index 100% rename from docs/sources/examples/mongodb/Dockerfile rename to docs/examples/mongodb/Dockerfile diff --git a/docs/sources/examples/nodejs_web_app.md b/docs/examples/nodejs_web_app.md similarity index 95% rename from docs/sources/examples/nodejs_web_app.md rename to docs/examples/nodejs_web_app.md index ff7179a811..f605f29c4e 100644 --- a/docs/sources/examples/nodejs_web_app.md +++ b/docs/examples/nodejs_web_app.md @@ -1,6 +1,12 @@ -page_title: Dockerizing a Node.js web app -page_description: Installing and running a Node.js app with Docker -page_keywords: docker, example, package installation, node, centos + # Dockerizing a Node.js web app diff --git a/docs/sources/examples/postgresql_service.Dockerfile b/docs/examples/postgresql_service.Dockerfile similarity index 100% rename from docs/sources/examples/postgresql_service.Dockerfile rename to docs/examples/postgresql_service.Dockerfile diff --git a/docs/sources/examples/postgresql_service.md b/docs/examples/postgresql_service.md similarity index 96% rename from docs/sources/examples/postgresql_service.md rename to docs/examples/postgresql_service.md index b49975a702..968cf7737a 100644 --- a/docs/sources/examples/postgresql_service.md +++ b/docs/examples/postgresql_service.md @@ -1,6 +1,12 @@ -page_title: Dockerizing PostgreSQL -page_description: Running and installing a PostgreSQL service -page_keywords: docker, example, package installation, postgresql + # Dockerizing PostgreSQL diff --git a/docs/sources/examples/running_redis_service.md b/docs/examples/running_redis_service.md similarity index 91% rename from docs/sources/examples/running_redis_service.md rename to docs/examples/running_redis_service.md index c46bb09c77..d8b673bdcd 100644 --- a/docs/sources/examples/running_redis_service.md +++ b/docs/examples/running_redis_service.md @@ -1,6 +1,12 @@ -page_title: Dockerizing a Redis service -page_description: Installing and running an redis service -page_keywords: docker, example, package installation, networking, redis + # Dockerizing a Redis service diff --git a/docs/sources/examples/running_riak_service.Dockerfile b/docs/examples/running_riak_service.Dockerfile similarity index 100% rename from docs/sources/examples/running_riak_service.Dockerfile rename to docs/examples/running_riak_service.Dockerfile diff --git a/docs/sources/examples/running_riak_service.md b/docs/examples/running_riak_service.md similarity index 92% rename from docs/sources/examples/running_riak_service.md rename to docs/examples/running_riak_service.md index 7450cd525d..b42a1af9b1 100644 --- a/docs/sources/examples/running_riak_service.md +++ b/docs/examples/running_riak_service.md @@ -1,6 +1,12 @@ -page_title: Dockerizing a Riak service -page_description: Build a Docker image with Riak pre-installed -page_keywords: docker, example, package installation, networking, riak + # Dockerizing a Riak service diff --git a/docs/sources/examples/running_ssh_service.Dockerfile b/docs/examples/running_ssh_service.Dockerfile similarity index 100% rename from docs/sources/examples/running_ssh_service.Dockerfile rename to docs/examples/running_ssh_service.Dockerfile diff --git a/docs/sources/examples/running_ssh_service.md b/docs/examples/running_ssh_service.md similarity index 90% rename from docs/sources/examples/running_ssh_service.md rename to docs/examples/running_ssh_service.md index b1000a04ac..c22e510cf6 100644 --- a/docs/sources/examples/running_ssh_service.md +++ b/docs/examples/running_ssh_service.md @@ -1,6 +1,12 @@ -page_title: Dockerizing an SSH service -page_description: Installing and running an SSHd service on Docker -page_keywords: docker, example, package installation, networking + # Dockerizing an SSH daemon service diff --git a/docs/sources/examples/supervisord.conf b/docs/examples/supervisord.conf similarity index 100% rename from docs/sources/examples/supervisord.conf rename to docs/examples/supervisord.conf diff --git a/docs/sources/include/no-remote-sudo.md b/docs/include/no-remote-sudo.md similarity index 100% rename from docs/sources/include/no-remote-sudo.md rename to docs/include/no-remote-sudo.md diff --git a/docs/sources/installation/SUSE.md b/docs/installation/SUSE.md similarity index 90% rename from docs/sources/installation/SUSE.md rename to docs/installation/SUSE.md index 106d4cbe31..18c075733e 100644 --- a/docs/sources/installation/SUSE.md +++ b/docs/installation/SUSE.md @@ -1,6 +1,12 @@ -page_title: Installation on openSUSE and SUSE Linux Enterprise -page_description: Installation instructions for Docker on openSUSE and on SUSE Linux Enterprise. -page_keywords: openSUSE, SUSE Linux Enterprise, SUSE, SLE, docker, documentation, installation + # openSUSE diff --git a/docs/sources/installation/amazon.md b/docs/installation/amazon.md similarity index 69% rename from docs/sources/installation/amazon.md rename to docs/installation/amazon.md index 3fdeb7228a..81e5a756eb 100644 --- a/docs/sources/installation/amazon.md +++ b/docs/installation/amazon.md @@ -1,6 +1,12 @@ -page_title: Installation on Amazon EC2 -page_description: Installation instructions for Docker on Amazon EC2. -page_keywords: amazon ec2, virtualization, cloud, docker, documentation, installation + ## Amazon EC2 diff --git a/docs/sources/installation/archlinux.md b/docs/installation/archlinux.md similarity index 88% rename from docs/sources/installation/archlinux.md rename to docs/installation/archlinux.md index 570e36c482..1a28c5b1aa 100644 --- a/docs/sources/installation/archlinux.md +++ b/docs/installation/archlinux.md @@ -1,6 +1,12 @@ -page_title: Installation on Arch Linux -page_description: Installation instructions for Docker on ArchLinux. -page_keywords: arch linux, virtualization, docker, documentation, installation + # Arch Linux diff --git a/docs/sources/installation/azure.md b/docs/installation/azure.md similarity index 72% rename from docs/sources/installation/azure.md rename to docs/installation/azure.md index 54910228ec..75c5726feb 100644 --- a/docs/sources/installation/azure.md +++ b/docs/installation/azure.md @@ -1,6 +1,12 @@ -page_title: Installation on Microsoft Azure platform -page_description: Instructions for creating a Docker-ready virtual machine on Microsoft Azure cloud platform. -page_keywords: Docker, Docker documentation, installation, azure, microsoft + # Microsoft Azure diff --git a/docs/sources/installation/binaries.md b/docs/installation/binaries.md similarity index 95% rename from docs/sources/installation/binaries.md rename to docs/installation/binaries.md index fc497867c1..14bf7c2e74 100644 --- a/docs/sources/installation/binaries.md +++ b/docs/installation/binaries.md @@ -1,6 +1,13 @@ -page_title: Installation from binaries -page_description: Instructions for installing Docker as a binary. Mostly meant for hackers who want to try out Docker on a variety of environments. -page_keywords: binaries, installation, docker, documentation, linux + # Binaries diff --git a/docs/sources/installation/centos.md b/docs/installation/centos.md similarity index 94% rename from docs/sources/installation/centos.md rename to docs/installation/centos.md index efebad503c..34203f9d47 100644 --- a/docs/sources/installation/centos.md +++ b/docs/installation/centos.md @@ -1,6 +1,12 @@ -page_title: Installation on CentOS -page_description: Instructions for installing Docker on CentOS -page_keywords: Docker, Docker documentation, requirements, linux, centos, epel, docker.io, docker-io + # CentOS diff --git a/docs/sources/installation/cruxlinux.md b/docs/installation/cruxlinux.md similarity index 90% rename from docs/sources/installation/cruxlinux.md rename to docs/installation/cruxlinux.md index e03715009f..e5276c9b7e 100644 --- a/docs/sources/installation/cruxlinux.md +++ b/docs/installation/cruxlinux.md @@ -1,6 +1,12 @@ -page_title: Installation on CRUX Linux -page_description: Docker installation on CRUX Linux. -page_keywords: crux linux, virtualization, Docker, documentation, installation + # CRUX Linux diff --git a/docs/sources/installation/debian.md b/docs/installation/debian.md similarity index 95% rename from docs/sources/installation/debian.md rename to docs/installation/debian.md index 883f920cdd..b49caf40b2 100644 --- a/docs/sources/installation/debian.md +++ b/docs/installation/debian.md @@ -1,6 +1,12 @@ -page_title: Installation on Debian -page_description: Instructions for installing Docker on Debian. -page_keywords: Docker, Docker documentation, installation, debian + # Debian diff --git a/docs/sources/installation/fedora.md b/docs/installation/fedora.md similarity index 93% rename from docs/sources/installation/fedora.md rename to docs/installation/fedora.md index b3f23e4514..a438426944 100644 --- a/docs/sources/installation/fedora.md +++ b/docs/installation/fedora.md @@ -1,6 +1,12 @@ -page_title: Installation on Fedora -page_description: Instructions for installing Docker on Fedora. -page_keywords: Docker, Docker documentation, Fedora, requirements, linux + # Fedora diff --git a/docs/sources/installation/frugalware.md b/docs/installation/frugalware.md similarity index 85% rename from docs/sources/installation/frugalware.md rename to docs/installation/frugalware.md index c700280346..d8c3ac6dc5 100644 --- a/docs/sources/installation/frugalware.md +++ b/docs/installation/frugalware.md @@ -1,6 +1,12 @@ -page_title: Installation on FrugalWare -page_description: Installation instructions for Docker on FrugalWare. -page_keywords: frugalware linux, virtualization, docker, documentation, installation + # FrugalWare diff --git a/docs/sources/installation/gentoolinux.md b/docs/installation/gentoolinux.md similarity index 94% rename from docs/sources/installation/gentoolinux.md rename to docs/installation/gentoolinux.md index 865e8eb008..f954e60ed5 100644 --- a/docs/sources/installation/gentoolinux.md +++ b/docs/installation/gentoolinux.md @@ -1,6 +1,12 @@ -page_title: Installation on Gentoo -page_description: Installation instructions for Docker on Gentoo. -page_keywords: gentoo linux, virtualization, docker, documentation, installation + # Gentoo diff --git a/docs/sources/installation/google.md b/docs/installation/google.md similarity index 81% rename from docs/sources/installation/google.md rename to docs/installation/google.md index 1cee5290da..b507f41b1a 100644 --- a/docs/sources/installation/google.md +++ b/docs/installation/google.md @@ -1,6 +1,12 @@ -page_title: Installation on Google Cloud Platform -page_description: Installation instructions for Docker on the Google Cloud Platform. -page_keywords: Docker, Docker documentation, installation, google, Google Compute Engine, Google Cloud Platform + # Google Cloud Platform diff --git a/docs/sources/installation/images/bad_host.png b/docs/installation/images/bad_host.png similarity index 100% rename from docs/sources/installation/images/bad_host.png rename to docs/installation/images/bad_host.png diff --git a/docs/sources/installation/images/cool_view.png b/docs/installation/images/cool_view.png similarity index 100% rename from docs/sources/installation/images/cool_view.png rename to docs/installation/images/cool_view.png diff --git a/docs/sources/installation/images/good_host.png b/docs/installation/images/good_host.png similarity index 100% rename from docs/sources/installation/images/good_host.png rename to docs/installation/images/good_host.png diff --git a/docs/sources/installation/images/kitematic.png b/docs/installation/images/kitematic.png similarity index 100% rename from docs/sources/installation/images/kitematic.png rename to docs/installation/images/kitematic.png diff --git a/docs/sources/installation/images/linux_docker_host.svg b/docs/installation/images/linux_docker_host.svg similarity index 100% rename from docs/sources/installation/images/linux_docker_host.svg rename to docs/installation/images/linux_docker_host.svg diff --git a/docs/sources/installation/images/mac_docker_host.svg b/docs/installation/images/mac_docker_host.svg similarity index 100% rename from docs/sources/installation/images/mac_docker_host.svg rename to docs/installation/images/mac_docker_host.svg diff --git a/docs/sources/installation/images/newsite_view.png b/docs/installation/images/newsite_view.png similarity index 100% rename from docs/sources/installation/images/newsite_view.png rename to docs/installation/images/newsite_view.png diff --git a/docs/sources/installation/images/osx-installer.png b/docs/installation/images/osx-installer.png similarity index 100% rename from docs/sources/installation/images/osx-installer.png rename to docs/installation/images/osx-installer.png diff --git a/docs/sources/installation/images/win_docker_host.svg b/docs/installation/images/win_docker_host.svg similarity index 100% rename from docs/sources/installation/images/win_docker_host.svg rename to docs/installation/images/win_docker_host.svg diff --git a/docs/sources/installation/images/windows-boot2docker-cmd.png b/docs/installation/images/windows-boot2docker-cmd.png similarity index 100% rename from docs/sources/installation/images/windows-boot2docker-cmd.png rename to docs/installation/images/windows-boot2docker-cmd.png diff --git a/docs/sources/installation/images/windows-boot2docker-powershell.png b/docs/installation/images/windows-boot2docker-powershell.png similarity index 100% rename from docs/sources/installation/images/windows-boot2docker-powershell.png rename to docs/installation/images/windows-boot2docker-powershell.png diff --git a/docs/sources/installation/images/windows-boot2docker-start.png b/docs/installation/images/windows-boot2docker-start.png similarity index 100% rename from docs/sources/installation/images/windows-boot2docker-start.png rename to docs/installation/images/windows-boot2docker-start.png diff --git a/docs/sources/installation/images/windows-installer.png b/docs/installation/images/windows-installer.png similarity index 100% rename from docs/sources/installation/images/windows-installer.png rename to docs/installation/images/windows-installer.png diff --git a/docs/sources/installation/joyent.md b/docs/installation/joyent.md similarity index 68% rename from docs/sources/installation/joyent.md rename to docs/installation/joyent.md index daa33b7996..b135fa5ed7 100644 --- a/docs/sources/installation/joyent.md +++ b/docs/installation/joyent.md @@ -1,6 +1,12 @@ -page_title: Install on Joyent Public Cloud -page_description: Installation instructions for Docker on the Joyent Compute Service. -page_keywords: Docker, Docker documentation, installation, joyent, Joyent Public Cloud, Joyent Compute Service, Joyent Container Service + ## Install on Joyent Public Cloud diff --git a/docs/sources/installation/mac.md b/docs/installation/mac.md similarity index 96% rename from docs/sources/installation/mac.md rename to docs/installation/mac.md index a27d042324..4c0c1e9442 100644 --- a/docs/sources/installation/mac.md +++ b/docs/installation/mac.md @@ -1,6 +1,12 @@ -page_title: Installation on Mac OS X -page_description: Instructions for installing Docker on OS X using boot2docker. -page_keywords: Docker, Docker documentation, requirements, boot2docker, VirtualBox, SSH, Linux, OSX, OS X, Mac + # Mac OS X @@ -8,7 +14,7 @@ You can install Docker using Boot2Docker to run `docker` commands at your comman Choose this installation if you are familiar with the command-line or plan to contribute to the Docker project on GitHub. -[Download Kitematic](https://kitematic.com/download) Alternatively, you may want to try ++++ +title = "Installation on Oracle Linux" +description = "Installation instructions for Docker on Oracle Linux." +keywords = ["Docker, Docker documentation, requirements, linux, rhel, centos, oracle, ol"] +[menu.main] +parent = "smn_linux" ++++ + # Oracle Linux 6 and 7 diff --git a/docs/sources/installation/rackspace.md b/docs/installation/rackspace.md similarity index 90% rename from docs/sources/installation/rackspace.md rename to docs/installation/rackspace.md index 9fddf5e450..07c04e877d 100644 --- a/docs/sources/installation/rackspace.md +++ b/docs/installation/rackspace.md @@ -1,6 +1,12 @@ -page_title: Installation on Rackspace Cloud -page_description: Installation instructions for Docker on Rackspace Cloud. -page_keywords: Rackspace Cloud, installation, docker, linux, ubuntu + # Rackspace Cloud diff --git a/docs/sources/installation/rhel.md b/docs/installation/rhel.md similarity index 94% rename from docs/sources/installation/rhel.md rename to docs/installation/rhel.md index 9b17346921..61291adcff 100644 --- a/docs/sources/installation/rhel.md +++ b/docs/installation/rhel.md @@ -1,6 +1,12 @@ -page_title: Installation on Red Hat Enterprise Linux -page_description: Instructions for installing Docker on Red Hat Enterprise Linux. -page_keywords: Docker, Docker documentation, requirements, linux, rhel + # Red Hat Enterprise Linux diff --git a/docs/sources/installation/softlayer.md b/docs/installation/softlayer.md similarity index 78% rename from docs/sources/installation/softlayer.md rename to docs/installation/softlayer.md index 5a11a47f49..622d0b1773 100644 --- a/docs/sources/installation/softlayer.md +++ b/docs/installation/softlayer.md @@ -1,6 +1,12 @@ -page_title: Installation on IBM SoftLayer -page_description: Installation instructions for Docker on IBM SoftLayer. -page_keywords: IBM SoftLayer, virtualization, cloud, docker, documentation, installation + # IBM SoftLayer diff --git a/docs/sources/installation/ubuntulinux.md b/docs/installation/ubuntulinux.md similarity index 97% rename from docs/sources/installation/ubuntulinux.md rename to docs/installation/ubuntulinux.md index 652edc9fd8..3163ee6521 100644 --- a/docs/sources/installation/ubuntulinux.md +++ b/docs/installation/ubuntulinux.md @@ -1,6 +1,12 @@ -page_title: Installation on Ubuntu -page_description: Instructions for installing Docker on Ubuntu. -page_keywords: Docker, Docker documentation, requirements, virtualbox, installation, ubuntu + #Ubuntu diff --git a/docs/sources/installation/windows.md b/docs/installation/windows.md similarity index 95% rename from docs/sources/installation/windows.md rename to docs/installation/windows.md index e56ad3abce..b03c945385 100644 --- a/docs/sources/installation/windows.md +++ b/docs/installation/windows.md @@ -1,6 +1,12 @@ -page_title: Installation on Windows -page_description: Docker installation on Microsoft Windows -page_keywords: Docker, Docker documentation, Windows, requirements, virtualbox, boot2docker + # Windows > **Note:** diff --git a/docs/sources/introduction/understanding-docker.md b/docs/introduction/understanding-docker.md similarity index 97% rename from docs/sources/introduction/understanding-docker.md rename to docs/introduction/understanding-docker.md index 060428ecc9..1b2fe94048 100644 --- a/docs/sources/introduction/understanding-docker.md +++ b/docs/introduction/understanding-docker.md @@ -1,8 +1,14 @@ -page_title: Understanding Docker -page_description: Docker explained in depth -page_keywords: docker, introduction, documentation, about, technology, understanding + -# Understanding Docker +# Understand the architecture **What is Docker?** Docker is an open platform for developing, shipping, and running applications. diff --git a/docs/sources/faq.md b/docs/misc/faq.md similarity index 98% rename from docs/sources/faq.md rename to docs/misc/faq.md index 0f64ff9b93..9aee9ed094 100644 --- a/docs/sources/faq.md +++ b/docs/misc/faq.md @@ -1,5 +1,13 @@ -page_title: FAQ page_description: Most frequently asked questions. -page_keywords: faq, questions, documentation, docker + # Frequently Asked Questions (FAQ) diff --git a/docs/sources/index.md b/docs/misc/index.md similarity index 93% rename from docs/sources/index.md rename to docs/misc/index.md index ef827acba1..532ddfd01d 100644 --- a/docs/sources/index.md +++ b/docs/misc/index.md @@ -1,6 +1,14 @@ -page_title: About Docker -page_description: Introduction to Docker. -page_keywords: docker, introduction, documentation, about, technology, understanding, Dockerfile + # About Docker diff --git a/docs/sources/release-notes.md b/docs/misc/release-notes.md similarity index 97% rename from docs/sources/release-notes.md rename to docs/misc/release-notes.md index 39d360ecde..aaf9dcdfce 100644 --- a/docs/sources/release-notes.md +++ b/docs/misc/release-notes.md @@ -1,6 +1,12 @@ -page_title: Docker 1.x series release notes -page_description: Release notes for Docker 1.x. -page_keywords: docker, documentation, about, technology, understanding, release + # Release notes version 1.6.0 (2015-04-16) diff --git a/docs/sources/search.md b/docs/misc/search.md similarity index 85% rename from docs/sources/search.md rename to docs/misc/search.md index 0e2e13fb08..277ba26ec6 100644 --- a/docs/sources/search.md +++ b/docs/misc/search.md @@ -1,3 +1,9 @@ + + # Search *Please activate JavaScript to enable the search functionality.* diff --git a/docs/sources/project/advanced-contributing.md b/docs/project/advanced-contributing.md similarity index 95% rename from docs/sources/project/advanced-contributing.md rename to docs/project/advanced-contributing.md index 6337a9588f..ce3514bcca 100644 --- a/docs/sources/project/advanced-contributing.md +++ b/docs/project/advanced-contributing.md @@ -1,6 +1,12 @@ -page_title: Advanced contributing -page_description: Explains workflows for refactor and design proposals -page_keywords: contribute, project, design, refactor, proposal + # Advanced contributing diff --git a/docs/sources/project/coding-style.md b/docs/project/coding-style.md similarity index 91% rename from docs/sources/project/coding-style.md rename to docs/project/coding-style.md index 7bc21e7376..3b2b3af10d 100644 --- a/docs/sources/project/coding-style.md +++ b/docs/project/coding-style.md @@ -1,6 +1,12 @@ -page_title: Coding style checklist -page_description: List of guidelines for coding Docker contributions -page_keywords: change, commit, squash, request, pull request, test, unit test, integration tests, Go, gofmt, LGTM + # Coding style checklist diff --git a/docs/sources/project/create-pr.md b/docs/project/create-pr.md similarity index 93% rename from docs/sources/project/create-pr.md rename to docs/project/create-pr.md index a40e3c56ce..1b6b0c98e7 100644 --- a/docs/sources/project/create-pr.md +++ b/docs/project/create-pr.md @@ -1,6 +1,12 @@ -page_title: Create a pull request (PR) -page_description: Basic workflow for Docker contributions -page_keywords: contribute, pull request, review, workflow, beginner, squash, commit + # Create a pull request (PR) diff --git a/docs/sources/project/doc-style.md b/docs/project/doc-style.md similarity index 97% rename from docs/sources/project/doc-style.md rename to docs/project/doc-style.md index db9c59429c..dfefc8fa34 100644 --- a/docs/sources/project/doc-style.md +++ b/docs/project/doc-style.md @@ -1,6 +1,12 @@ -page_title: Style guide for Docker documentation -page_description: Style guide for Docker documentation describing standards and conventions for contributors -page_keywords: style, guide, docker, documentation + # Docker documentation: style & grammar conventions diff --git a/docs/sources/project/find-an-issue.md b/docs/project/find-an-issue.md similarity index 97% rename from docs/sources/project/find-an-issue.md rename to docs/project/find-an-issue.md index 3e853a6030..d1d45d725b 100644 --- a/docs/sources/project/find-an-issue.md +++ b/docs/project/find-an-issue.md @@ -1,6 +1,12 @@ -page_title: Make a project contribution -page_description: Basic workflow for Docker contributions -page_keywords: contribute, pull request, review, workflow, beginner, expert, squash, commit +