How to build the docs

Ingo_Richtsmeier · August 14, 2017, 8:55am

Hi,

how can I build the docs to surf them offline on my computer?

Thanks, Ingo

menski · August 14, 2017, 9:00am

Hi Ingo,

you need mdbook which you can download on github:

Then run it in the docs folder:

Cheers,
Sebastian

DanielMeyer · August 14, 2017, 10:58am

github.com

zeebe-io/zeebe/blob/master/CONTRIBUTING.md#building-the-documentation

# Contributing to Zeebe

## Building Zeebe from source

Zeebe is developed as multi module maven project. To build all components
run the command `mvn clean install -DskipTests` in the root folder.

The resulting Zeebe distribution can be found in the folder `dist/target`, i.e.
```
dist/target/zeebe-distribution-X.Y.Z-SNAPSHOT.tar.gz
dist/target/zeebe-distribution-X.Y.Z-SNAPSHOT.zip
```

This is a small overview of the contents of the different modules:
- `util` contains custom implementations of building blocks like an actor scheduler, buffer allocations, metrics. Its parts are used in most of the other modules
- `zb-map` is a custom in memory hash map implementation
- `protocol` contains the SBE definition of the main message protocol
- `bpmn-model` is a Java API for BPMN process definitions used for parsing etc.
- `msgpack-*` is custom msgpack implementation with extensions to evaluate json-path expressions on msgpack objects
- `dispatcher` is a custom implementation of message passing between threads

This file has been truncated. show original

system · January 31, 2024, 10:08am