This is your definite place to contribute to the docker documentation. The documentation is generated from the .rst files under sources.
The folder also contains the other files to create the http://docker.io website, but you can generally ignore most of those.
pip install sphinx
[sudo] pip-2.7 install sphinx
)pip install sphinxcontrib-httpdomain
[sudo] pip-2.7 install sphinxcontrib-httpdomain
.rst
files with your favorite editor to your liking.make docs
to clean up old files and generate new ones._build
directory.make server
and 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 carefull 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.less
or 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.)
The _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::
Code examples
Start without $, so it's easy to copy and paste.