Numahop technical documentation.

This documentation is using mdbook and schemaspy.

Note: This documentation is very incomplete and in its early stages.

Dependencies

For building

• mdbook
• mdbook-mermaid

For updating the generated part of the documentation.

• A running NumaHOP instance.
• bash
• nu (Temporary: will be replaced by a mdbook preprocessor at a certain point. Used for the api page.)
• OpenJdk17
• wget
• schemaspy jar
• mariadb-j-connector jar

Generated documentation.

Some part of the documentation is generated and needs a Numahop Installation to the version for which you want to generate the documentation. In the scripts folder there are the scripts used to update the generated part of the documentation. In the gen folder there are the cached generated documentation pieces allowing to build for the latest NumaHOP release.

Building and consulting offline.

The setup rule of the makefile fetches the correct mdbook version, mdbook preprocessors, and the schemaspy needed jars. But everything is compiled if you don't trust fetching the compiled versions from the web you can fetch them yourself. And place them in the vendor folder.

make setup # Only once when cloning the repository
make build
make open

To watch changes and rebuild the book on changes.

vendor/mdbook serve 

Caution when using mdbook-serve the db page is wiped in the output directory by mdbook at each rebuild. See #2573 for more information.