5e6d8a03fc
* Added documentation for download status of ddi feedback Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io> * Added download status to cancelAction docs Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io> * Fixed some typos in documentation Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io> * Added download status to ddi_api.md and added missing quotation marks Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io> * Added mising of in documentation Signed-off-by: Alexander Dobler <alexander.dobler3@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