Hi all, the documentation team has made a few changes to the docs.theforeman.org website by merging these PRs:
- Rework navigation structure to simplify it by aneta-petrova · Pull Request #4068 · theforeman/foreman-documentation · GitHub updated how users navigate to find the guide they need. Before, there were 4 items in the navigation bar (choose version and then choose flavor or change flavor and then choose version). Now, we provide only one of these paths (choose version and then choose flavor).
- This update freed up a lot more space for other useful items to be added to the navigation bar! Which is why Update website top navigation bar by aneta-petrova · Pull Request #3670 · theforeman/foreman-documentation · GitHub added a few new items: the “Foreman docs” text, a link to this forum, and a link to contribute.
- Add a banner for unsupported and pre-release by aneta-petrova · Pull Request #3653 · theforeman/foreman-documentation · GitHub added banners to let users know that they are browsing a pre-release version or a version that’s no longer supported. (Okay, this was a partial success because right now, only the pre-release banner is displayed for “nightly” guides. Add Release Candidate Banner · Issue #695 · theforeman/foreman-documentation · GitHub tracks the issue of the “Unsupported version” banner not being displayed.)
We would also like to follow up on these initial updates, for example through issues like these:
- An '(inline) issue reporting' feature for docs.theforeman.org · Issue #3640 · theforeman/foreman-documentation · GitHub to provide an easy way for users to open an issue against documentation
- Continue updating website navigation · Issue #4079 · theforeman/foreman-documentation · GitHub to provide a quicker way to navigate through our guides collection for users who already know what they want
We welcome feedback so please let us know what you think and feel free to share your opinions here, on GitHub in issues and PRs, or in the docs Matrix chat.
