70d0fe879e
* Extend DS invalidation dialog to include mass-cancellation of actions Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> add component id for cancelation type radio buttons Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * add infos about ds invalidation to UI documentation; update UI images; add screenshot about ds invalidation Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * fix review findings Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * add link property to invalidation docu Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * Put invalidation counts into one object Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * add hint to invalidation dialog, that invalidation is unrepeatable Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * disable invalidate button if insufficient permission Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * fix auto assignment error with insufficient permission Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * implement permissions check for invalidation dialog Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * add update_target permission to api doc description Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io>
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