d958d8e82c
This functionallity seems to get via AMQP (after some authentication) a private (wihtout need of authentication) url to an artifact assigned to the controller. By default, DDI or DMF shall provide proper urls (for direct download) to devices and if they have to be without authentication this shall be solved in different ways - for instance separate download server providing dedicated private / signed urls. This functinallity is not a real hawkBit part but more like something intended to solve some edge cases. Since it is complicated, heeds support, doesn't solve wide spread use cases, and could be achieved with other means - better to be removed. Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.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 NODE.js and npm see installing Node.js and npm documentation on how to install Node.js and npm
- Install Redocly CLI see installing Redocly CLI documentation on how to install Redocly CLI
- 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 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