Files
hawkbit/docs
Bondar Bogdan 664c467920 Feature soft autoassignment (#789)
* Repository layer and database migration
* Changed target filter management to update auto assignment action type together with distribution set, extended mgmt API, adapted auto assign checker/scheduler, changed auto assign distribution set select table to combobox, added filter functionality (needs refactoring)
* Refactored auto assignment dialog window, added soft/forced option group, restructured action type option group layout
* Added forced icon to target filter table autoassignment cell for the forced auto assign actions
* First working draft of distribution set select combobox for auto assignment window
* Optimised filtering queries, added alphabetical sorting on distribution set name and version
* Refactoring of distribution bean query for lazy loading
* Distribution set combobox refactoring and comments
* Added verification of auto assign distribution set validity (completed, not deleted), exdended target filter query fields with auto assign action type field, added rsql filter tests, added repository layer tests
* Added mgmt API tests
* Changed target filter rest docu tests to include auto-assignment type
* Updated hawkbit docs with auto-assignment description
* Added debouncing to key and value input fields of metadata popup layout to get rid of unnecessary value change events, removed redundant set value call in common dialog window, minimizing the repaint components calls
* Fixed sonar findings
* Reverted changes of common dialog window validaton, setting the value of the field explicitly as before, until we rethink the whole concept of validaton mechanism
* Fixed review findings
* Removed rsql filtering by filter auto-assign action type, due to missing conversion of disallowed timeforced action type
* Small fix regarding usage of page request
* Updated sql script version for flyway
* Extended tests for soft deleted distribution sets for auto-assignment and filter string within distribution set specification builder

Signed-off-by: Bogdan Bondar <Bogdan.Bondar@bosch-si.com>
2019-03-13 13:35:22 +01:00
..
2018-10-16 11:14:52 +02:00
2019-03-13 13:35:22 +01:00

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

  1. Install Hugo: see installing Hugo 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/
  • 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