be3dfbf617
* Adapted code to allow '.' inside of metadata key and attribute names Signed-off-by: Markus Block <markus.block@bosch-si.com> * added handling of corner cases Signed-off-by: Markus Block <markus.block@bosch-si.com> * Adapted metadata and attribute tests to check that dot is allowed Signed-off-by: Markus Block <markus.block@bosch-si.com> * fixed documentation Signed-off-by: Markus Block <markus.block@bosch-si.com> * Allow usage of dot in key names for every map attribute, e.g. also for metadata in distribution set Signed-off-by: Markus Block <markus.block@bosch-si.com> * fixed typo Signed-off-by: Markus Block <markus.block@bosch-si.com> * adapted test key to ensure a dot can be used Signed-off-by: Markus Block <markus.block@bosch-si.com> * fixed typo Signed-off-by: Markus Block <markus.block@bosch-si.com>
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
- Install Hugo: see installing Hugo documentation on how to install Hugo.
- Install hawkBit: run
mvn installin 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 tocontent/rest-api/and ii. downloads the required Hugo thememvn site: Serve the documentation on localhost:1313/hawkbit/mvn clean: Delete generated artifacts (REST docs, Hugo theme)
Note: Currently, only Unix/macOS is supported! For Windows, use the hugo commands in CMD.
Generate /public folder
In order to generate the /public folder, which can be put on a web-server, run the following command:
$ hugo