3978454900
* Generating rest doc from swagger json Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * refactoring and adding doc Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * refactoring Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * Don't directly inject files in the executable jar since it brakes it Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * using the attachArtifact configuration to generate secondary artifact Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * Splitting the json documentation into mgmt and ddi. And some refactoring Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * refactoring Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * Split mgmt and DDI components from the json Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> --------- Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com>
27 lines
1.6 KiB
Markdown
27 lines
1.6 KiB
Markdown
# Eclipse hawkBit Documentation
|
|
The hawkBit documentation is built with [Hugo](https://www.gohugo.io/) using the [Material](http://github.com/digitalcraftsman/hugo-material-docs)
|
|
theme. Compiling the documentation is not included within the regular Maven build.
|
|
|
|
## Prerequisites
|
|
1. **Install Hugo**: see [installing Hugo](https://gohugo.io/getting-started/installing/) documentation on how to install Hugo.
|
|
2. **INSTALL JQ**: see [installing jq](https://jqlang.github.io/jq/download/) documentation on how to install jq.
|
|
3. **Install NODE.js and npm** see [installing Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) documentation on how to install Node.js and npm
|
|
4. **Install Redocly CLI** see [installing Redocly CLI](https://redocly.com/docs/cli/installation/) documentation on how to install Redocly CLI
|
|
5. **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/](http://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:
|
|
|
|
```bash
|
|
$ hugo
|
|
``` |