Zeebe - Documentation

This module contains the source of the documentation that is published at https://docs.zeebe.io/.

Building the documentation locally

The documentation is generated by mdbook.

1. Install the latest mdbook version, see installation instructions on GitHub.
2. Install the link checking backend for mdbook, see installation instructions on GitHub.
3. Go to the docs folder in the Zeebe repository
4. Run the command mdbook serve to start the web server. It will generate the documentation on every change.
5. See the documentation at http://localhost:3000

Writing documentation

The documentation is written in Markdown.

The important folders/files are:

• docs/src - Markdown files grouped by sections + PNG images
  • SUMMARY.md - the table of content (updated manually)
• docs/media-src - BPMN files to create the images from
• Google Drive - sources of other graphics/diagrams

Releasing the documentation

When a pull request is merged to develop then it generates the documentation and publish it to https://stage.docs.zeebe.io/.

The documentation is usually published from the stage environment to https://docs.zeebe.io/ during the release. However, it can be manually triggered using the Zeebe CI job if needed.