This is your definite place to contribute to the docker documentation. After each push to master the documentation is automatically generated and made available on docs.docker.io
Each of the .rst files under sources reflects a page on the documentation.
pip install sphinx
[sudo] pip-2.7 install sphinx)
pip install sphinxcontrib-httpdomain
[sudo] pip-2.7 install sphinxcontrib-httpdomain
.rstfiles with your favorite editor to your liking.
make docsto clean up old files and generate new ones.
make serverand open http://localhost:8000/ in your favorite browser.
Alternatively, for small changes and typo‘s you might want to use GitHub’s built in file editor. It allows you to preview your changes right online. Just be careful not to create many commits.
When you need to add images, try to make them as small as possible (e.g. as gif).
lessc main.lessor watched using watch-lessc
watch-lessc -i main.less -o main.css
To make links to certain pages create a link target like so:
.. _hello_world: Hello world =========== This is.. (etc.)
_hello_world: will make it possible to link to this position (page and marker) from all other pages.
Notes, warnings and alarms
# a note (use when something is important) .. note:: # a warning (orange) .. warning:: # danger (red, use sparsely) .. danger::
Start without $, so it's easy to copy and paste.
man _build/man/docker.1, where _build/man/docker.1 is the path to the generated manfile