This repository stores the source of the OTOBO Administration Manual.
The content of the documentation is in reStructuredText format and uses Sphinx to generate HTML, PDF and EPUB outputs. The various outputs can be seen on the OTOBO Documentation page.
To verify changes to the documentation before submitting them, you can generate a local HTML preview. This helps identify syntax errors in ReStructuredText (RST) or layout issues early in the process.
git clone https://github.com/RotherOSS/doc-otobo-admin.git
cd doc-otobo-admin- Python3
make(standard on Linux/macOS; for Windows use MinGW or WSL)
Use the provided Makefile for the build.
It will manage a virtual environment in .venv for you.
make autoOnce the build is complete, it will open your browser and show the result.
Call help to see all targets.
make helpNote
This local build uses default settings (e.g., version "dev"). Final versioning, branding, and language validation are performed automatically by the OTOBO CI Pipeline as soon as changes are pushed to the repository.
Contribution to documentation is very welcome. You can add new pages or edit the existing text. To edit the documentation:
- Learn how to work with reStructureText (see help).
- Fork the repository (see help).
- Add your modifications to the documentation.
- Create a pull request (see help).
Translators should use Weblate to translate the documentation. As the documentation is in reStructuredText format, be careful not to break the structure while translating the documentation. See the examples in the Translating section of the developer documentation.
If you find any kind of bugs in the documentation like typos, wrong information, dead links, etc., please create a bug report on Github issue tracker.
The documentation is distributed under the GNU Free Documentation License - see the accompanying COPYING file for more details.