Zammad user documentation

If you want to contribute to the Zammad documentation you can edit the rst files and create pull requests.

We take care about the translation part, so please don't change anything else whithin the repository. These changes would be discarded anyway ;)

Note:

*Please modify only .rst files the *.PO and *.MO files are autogenerated!

If you like to edit the docs use the ReStructuredText markup language. Info about this markup language can be found at:

Thanks! ❤ ❤ ❤

Zammad Team

If you want to test the docs for yourself you need a local installation of sphinx and gettext.

pip install sphinx sphinx-autobuild sphinx-intl sphinx_rtd_theme

make html

If you have to work on the translations you need gettext.

For OS X use HomeBrew or build from source. For Linux use your package manager.

brew install gettext

The workflow itself

tx init

tx set --source -r <project_slug.resource_slug> -l <lang> <file>

make clean

make gettext

sphinx-intl update -p _build/locale/ -l de -l en

sphinx-intl update-txconfig-resources --pot-dir _build/locale --transifex-project-name zammad-user-documentation

tx push -s

tx pull -l en

sh build_mo.sh

After a successful build, push to this repo and readthedocs will update itself.

make -e SPHINXOPTS="-D language='de'" html
make -e SPHINXOPTS="-D language='en'" html