From a8f2402b87242471eb8ec9afc7520c6f29ad823c Mon Sep 17 00:00:00 2001 From: James Turnbull Date: Wed, 14 May 2014 20:12:42 +0200 Subject: [PATCH] Minor fixups to the Docs README Docker-DCO-1.1-Signed-off-by: James Turnbull (github: jamtur01) --- docs/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index 71ce548003..fa3c501087 100755 --- a/docs/README.md +++ b/docs/README.md @@ -1,12 +1,12 @@ # Docker Documentation The source for Docker documentation is here under `sources/` and uses extended -Markdown, as implemented by [mkdocs](http://mkdocs.org). +Markdown, as implemented by [MkDocs](http://mkdocs.org). The HTML files are built and hosted on `https://docs.docker.io`, and update automatically after each change to the master or release branch of [Docker on GitHub](https://github.com/dotcloud/docker) thanks to post-commit hooks. The -"docs" branch maps to the "latest" documentation and the "master" (unreleased +`docs` branch maps to the "latest" documentation and the `master` (unreleased development) branch maps to the "master" documentation. ## Branches @@ -22,11 +22,11 @@ base your changes on the `docs` branch. Also, now that we have a `docs` branch, we can keep the [http://docs.docker.io](http://docs.docker.io) docs up to date with any bugs -found between `docker` code releases. +found between Docker code releases. **Warning**: When *reading* the docs, the [http://beta-docs.docker.io](http://beta-docs.docker.io) documentation may -include features not yet part of any official docker release. The `beta-docs` +include features not yet part of any official Docker release. The `beta-docs` site should be used only for understanding bleeding-edge development and `docs.docker.io` (which points to the `docs` branch`) should be used for the latest official release.