Files

Jeroen Laverman ea7d85a15c Fix Typos and remove unchanged theme files (#719 )

* Fix Typos and remove unchanged theme files

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

* Add Sandbox to getting started section
* fix glitch in UI description

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

2018-08-23 13:29:08 +02:00

content

Fix Typos and remove unchanged theme files (#719 )

2018-08-23 13:29:08 +02:00

layouts

Fix Typos and remove unchanged theme files (#719 )

2018-08-23 13:29:08 +02:00

static

Fix Typos and remove unchanged theme files (#719 )

2018-08-23 13:29:08 +02:00

cleanup.sh

Introduce new, Hugo templates based, website (#713 )

2018-08-01 11:01:02 +02:00

config.toml

Introduce new, Hugo templates based, website (#713 )

2018-08-01 11:01:02 +02:00

install-theme.sh

Fix Typos and remove unchanged theme files (#719 )

2018-08-23 13:29:08 +02:00

pom.xml

Introduce new, Hugo templates based, website (#713 )

2018-08-01 11:01:02 +02:00

README.md

Introduce new, Hugo templates based, website (#713 )

2018-08-01 11:01:02 +02:00

README.md

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 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/
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