As far as I can tell, @jeremylenz has merged the first commit to Katello which links to the “next generation documentation” on docs.theforeman.org. Up until now, all
Documentation buttons have linked to the Foreman Manual.
I found another commit by @lstejskal which I don’t fully understand yet due to
I believe this is a great achievement for both Foreman/Katello developers and everyone contributing to Foreman documentation. It shows the maturity of the open source documentation.
I want to take this opportunity to start a discussion on the following items:
- Convert existing links to point to docs.theforeman.org? This could be a follow-up task to the current task of Making docs.theforeman.org the primary documentation source.
- Add more
Documentationbuttons to all appropriate places? I believe it’s possible throughout React-based UI in Katello.
- Maintaining those anchors: For future Katello releases, we need to ensure that we do not change existing anchors within foreman-documentation (example). Up until now, we’re pretty liberal with backporting changes to the documentation. I believe we might need automated checks to not release Katello with broken links and to not break links in released versions of Katello. cc @docs
Any input and knowledge transfer is highly appreciated.