Commit Graph

5 Commits

Author SHA1 Message Date
Denislav Prinov
3978454900 HTTP documentation generation from OpenApi documentation (#1438)
* 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>
2023-09-27 11:44:30 +03:00
Avgustin Marinov
db571be81c Fixing missing API doc (#1403)
fixed by adding
```
[markup]
	[markup.goldmark]
        [markup.goldmark.renderer]
            unsafe = true
```

otherwise hugo removes raw html (as the iframes) + links points to
concrete html files
2023-07-28 10:16:54 +02:00
Alexander Dobler
5e6d8a03fc Added documentation for download status of ddi feedback (#985)
* Added documentation for download status of ddi feedback

Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io>

* Added download status to cancelAction docs

Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io>

* Fixed some typos in documentation

Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io>

* Added download status to ddi_api.md and added missing quotation marks

Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io>

* Added mising of in documentation

Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io>
2020-08-03 13:14:41 +02:00
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
Jeroen Laverman
f96876afe0 Introduce new, Hugo templates based, website (#713)
* 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>
2018-08-01 11:01:02 +02:00