This documentation is available in multiple formats.
The documentation is build using GitBook software from Markdown files in the documentation repository.
We encourage you to participate in improving the documentation. From corrected typos to new sections, every commit is appreciated. You can access the source files by clicking the "Fix this page"-button in the GitBook or by selecting the relevant Markdown-file in the documentation. You can commit your changes by sending a pull request.
Fork the repo, do work in a feature branch.
Issue a pull request.
Make sure the automated test suite succeeds. They will show-up in the pull request.
Sign the CLA using cla-assistant (a comment by CLAAdmin will appear for your pull request to help you out).
Assign a maintainer or other developer on this topic to accept/evaluate your pull request. The current maintainer can be found in the governance paragraph.
If you are completely new to this and you need help to get started, file an issue in the documentation repository.
It may be obvious to you already from the index, however, here is an overview on what documentation goes in which chapter.
We have chosen to work with GitBook since it allows us to make different versions of documentation for each release. This is done by branching the files in the documentation repository. The master branch is used for releases only. The development branch is our main and current branch. If you like to improve the documentation, start a feature branch with your changes and send a pull request to the development branch.
Inspiration on how to write good documentation can be found here: http://docs.writethedocs.org/.