Zammad Admin Documentation
Source files for Zammad’s admin documentation.
If you would like to improve the docs, simply:
- fork the repo,
- edit the appropriate
.rstfiles (see Markup Format below), and
- submit a pull request.
🌍Wanna help translate? Submit your contributions (or request additional languages) here. Do NOT submit a PR with changes to the contents of the
The Zammad Team
If you like to edit the docs use the ReStructuredText markup language. Information about this markup language can be found at:
This documentation provides versions:
pre-releasecan contain develop, not yet released functions and changes
latest(and stable) version of the repository
stable-x.xis the old back port for an earlier version
- These branches do not receive further updates and serve as historic help for administrators
Notes on Documentation Branches and Pull Requests
Please note that this repository uses protected branches.
The most current version is always
pre-release - if you create
Pull Requests, please use
pre-release as destination Branch.
This will ensure that your changes are available upon merge.
$ pip install sphinx sphinx-autobuild sphinx-intl sphinx_rtd_theme sphinx-tabs
$ brew install gettext # macOS $ sudo apt install gettext # Debian / Ubuntu $ sudo dnf install gettext # Fedora
Example for a local HTML build
Localization using Weblate
This documentation is translated via Weblate. After changing or adding text in this documentation, updating the POT file is required. (This is usually done by us after QA before merging the PR)
Weblate will automatically provide the translation parts in in its UI for
all available languages. If there's translation progress it will automatically
provide pull requests on this repository.
Pull requests containing direct translations within the PO files will be denied.
# ensure clean enviroment $ make clean # generate the strings from the *.rst files $ make gettext # manual language-based build (`_build/html/`) (for testing) $ make -e SPHINXOPTS="-D language='de'" html $ make -e SPHINXOPTS="-D language='en'" html
If you have a problem with creating / building the documentation, please create an issue. Thanks.