Status: Closed (View Workflow)
Affects Version/s: None
Fix Version/s: None
Security Level: Default (Default Security Scheme)
Why is should we evaluate a documentation framework?
The documentation right now is represented as a big single page. This works for a certain size of documentation. The size of features and functionalities of OpenNMS require a more sophisticated framework providing search. Additionally, the usability, readability lacks with having everything rendered in a single big HTML file. The long navigation with the many topics becomes hard to handle and use.
- AsciiDoc support
- It would be nice to follow a jamstack.org approach to be hosted easily as a static website on a CDN and locally shipped with the product for offline usage
- Integration in our CI/CD for release management
- Allows keeping docs in the source repository to be treated as code and can be versioned and released along with the product
- Allows integration of different products like Helm, OpenNMS-JS, Horizon and Meridian