lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Documentations fixes & epl 2.0 news (#1429)

Browse Source 
Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
This commit is contained in:
Avgustin Marinov
2023-09-14 15:40:09 +03:00
committed by GitHub
parent 8558b96de1
commit 87107ef724
5 changed files with 83 additions and 702 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/README.md
View File

@@ -11,12 +11,11 @@ theme. Compiling the documentation is not included within the regular Maven buil
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 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)
_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: