0ct0pu5/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #5801 from jamtur01/fixups

Browse source 
Minor fixups to the Docs README
This commit is contained in:
Sven Dowideit 2014-05-15 09:38:52 +10:00
commit d9e3d88082
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/README.md
View file

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