hawkbit icon indicating copy to clipboard operation
hawkbit copied to clipboard
verified publisher icon eclipse

Feature request: Ensure consistency of documentation/actuality of static website

Open mc-xyz opened this issue 4 months ago • 3 comments

The documentation of important (e.g. security related) configuration and interfaces is not consistent. For developers like us it's usual to search in the source code directly. For project managers and more management related roles the website is the first place to go however. This can create a lot of confusion and could be fixed pretty easily actually.

The most common way to prevent from this issue is to build the website from the source code repository in a single-repo manner. This way the github CI workflow steps can be configured to depend on each other and allows to implement always in sync documentation.

One example is e.g. the documentation website of FastAPI which is built from corresponding *.md files in the source code repository. Docs are built and deployed with corresponding workflow runs here and here as part of a single CI pipeline. This would be consistent with the hawkbit github actions workflows which run concurrently as well. Even better would be to make the docs deployment depend on the hawkbit release.

All the below issues and future ones could be solved with a feature like this.

Issue related to a possible solution implementation:

  • https://github.com/eclipse-hawkbit/hawkbit/issues/2612

Related issues are:

  • https://github.com/eclipse-hawkbit/hawkbit/issues/1413
  • https://github.com/eclipse-hawkbit/hawkbit/issues/1757
  • https://github.com/eclipse-hawkbit/hawkbit/issues/1387
  • https://github.com/eclipse-hawkbit/hawkbit/issues/966
  • https://github.com/eclipse-hawkbit/hawkbit-website/issues/9
  • https://github.com/eclipse-hawkbit/hawkbit/issues/1699

Documentation contained in github issue history only:

  • https://github.com/eclipse-hawkbit/hawkbit/issues/2557
  • https://github.com/eclipse-hawkbit/hawkbit/issues/2394
  • https://github.com/eclipse-hawkbit/hawkbit/issues/2362
  • https://github.com/eclipse-hawkbit/hawkbit/issues/1229
  • https://github.com/eclipse-hawkbit/hawkbit/issues/1069
  • https://github.com/eclipse-hawkbit/hawkbit/issues/598

mc-xyz avatar Aug 25 '25 17:08 mc-xyz