(pre-release)

(latest)

Zammad Admin Documentation

Source files for Zammad’s admin documentation (latest / pre-release).

Contributing

Please see the Contributing section in this manual.

Compilation

Dependencies

Either install the dependencies on your machine or use a devcontainer, see next section.

• sphinx

  $ pip install -r requirements.txt
  

• gettext

  $ brew install gettext              # macOS
  $ sudo apt install gettext          # Debian / Ubuntu
  $ sudo dnf install gettext          # Fedora
  

Devcontainer

If you can't or don't want to install the dependencies on your system, you can use a devcontainer. The repo is prepared so you just need a supported editor (e.g. VS Code) and a Docker installation on your system.

Simply open the cloned repo in a supported editor and it should ask you to open the folder in a container. After it got set up, you can compile the docs with your changes locally.

For more information, check these resources:

• https://github.com/devcontainers/
• https://containers.dev/

Example for a local HTML build

$ make html

Building for a specific language:

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

Update of Translation Catalog

Before creating a pull request, make sure to update the translation catalog after your last changes:

$ make gettext