f96876afe0
* Add new hugo-based website for hawkBit Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Fix broken links + wordings - , i.e. -> i.e, - , e.g. -> e.g., - hawkbit -> hawkBit - don't -> do not - isn't -> is not Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Remove old documentation and add maven integration Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Add Intellij files to ignore Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Update README Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Update Copyright header * exclude website artifacts Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Harmonize usage of i.e. and e.g. Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Add remark for windows user Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Fix indention Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Introduce review findings Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Change image in 'run hawkbit' guide Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>
25 lines
1.1 KiB
Markdown
25 lines
1.1 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 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/](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:
|
|
|
|
```bash
|
|
$ hugo
|
|
``` |