Contributing to the Documentation

The documentation is as important as the code. It follows the exact same principles: DRY, tests, ease of maintenance, extensibility, optimization, and refactoring just to name a few. And of course, documentation has bugs, typos, hard to read tutorials, and many more.

Testing Documentation

To test the documentation before a commit:

• Install pip, the Python package manager,
• Download the documentation requirements,

$ pip install -r docs/requirements.txt
# This makes sure that the version of Sphinx you'll get is >=1.4!

$ pip install git+https://github.com/fabpot/sphinx-php.git
# This install the sphinx-php extension

• Install Sphinx,

$ pip install Sphinx

• In the docs directory run sphinx-build -b html . build and view the generated HTML files in the build directory.

Standards

All documentation in the Openjet Documentation should follow the documentation standards.

Reporting an issue

The easiest contributions you can make is reporting issues: a typo, a grammar mistake, a bug in a code example, a missing explanation, and so on.

Steps:

• Submit a new issue in the Gitlab tracker;
• (optional) Submit a patch.