hawkbit/docs/README.md

Eclipse hawkBit Documentation

The hawkBit documentation is built with Hugo using the Material theme. Compiling the documentation is not included within the regular Maven build.

Prerequisites

1. Install Hugo: see installing Hugo documentation on how to install Hugo.
2. Install hawkBit: run mvn install in the parent directory to generate the latest REST docs for hawkBit.

Build and Serve documentation

The following Maven targets are available in order to build and serve the documentation:

• mvn install: i. Copies the generated REST docs to content/rest-api/ and ii. downloads the required Hugo theme

• mvn site: Serve the documentation on localhost:1313/hawkbit/

  Note: the local port could be different. Please, look at the mvn site command output.

• mvn clean: Delete generated artifacts (REST docs, Hugo theme)

Generate /public folder

In order to generate the /public folder, which can be put on a web-server, run the following command:

$ hugo