Documentation team meeting 2025-02-13

aneta-petrova · February 4, 2025, 2:26pm

Triaging documentation PRs and issues. Feel free to bring your own topics for discussion. More details in the Foreman docs Matrix chat .

aneta-petrova · February 12, 2025, 12:42pm

I’d like to demo two of my recent PRs that affect the docs.theforeman.org page:

github.com/theforeman/foreman-documentation

Add a banner for unsupported and pre-release

theforeman:master ← aneta-petrova:ribbon

opened 08:11PM - 11 Feb 25 UTC

aneta-petrova

+175 -2

#### What changes are you introducing? This should show a banner/ribbon for a…ll guides in nightly and unsupported releases, with a link leading to the main docs.theforeman.org page where users can read more information on supported releases. #### Why are you introducing these changes? (Explanation, links to references, issues, etc.) Solution suggested in https://github.com/theforeman/foreman-documentation/issues/695#issuecomment-2582965615 #### Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.) Credit: https://simonwhitaker.github.io/github-fork-ribbon-css/ #### Checklists * [x] I am okay with my commits getting squashed when you merge this PR. * [x] I am familiar with the [contributing](https://github.com/theforeman/foreman-documentation/blob/master/CONTRIBUTING.md) guidelines. Please cherry-pick my commits into: * [ ] Foreman 3.13/Katello 4.15 (EL9 only) * [ ] Foreman 3.12/Katello 4.14 (Satellite 6.16) * [ ] Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9) * [ ] Foreman 3.10/Katello 4.12 * [ ] Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10) * [ ] Foreman 3.8/Katello 4.10 * [ ] Foreman 3.7/Katello 4.9 (Satellite 6.14) * We do not accept PRs for Foreman older than 3.7.

github.com/theforeman/foreman-documentation

Simplify flavor+version navigation paths

theforeman:master ← aneta-petrova:web-collapsibles

opened 12:40PM - 12 Feb 25 UTC

aneta-petrova

+287 -2705

#### What changes are you introducing? I'm trying to simplify the way users c…an navigate docs.theforeman.org, namely by: * Removing the current flavor dropdowns from the top menu bar and replacing them with new version pages, each with collapsible lists * Removing a few links from the main landing page and adding them to the top menu bar instead #### Why are you introducing these changes? (Explanation, links to references, issues, etc.) I'm trying to address these issues that currently affect docs.theforeman.org: * Users can't use full-text search to find the guide they need * Navigating between the flavors and versions is not straightforward enough #### Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.) That's a lot of changes in a single PR. Based on how the reviews go, I can break it into smaller ones. #### Checklists * [ ] I am okay with my commits getting squashed when you merge this PR. * [x] I am familiar with the [contributing](https://github.com/theforeman/foreman-documentation/blob/master/CONTRIBUTING.md) guidelines. Please cherry-pick my commits into: * [ ] Foreman 3.13/Katello 4.15 (EL9 only) * [ ] Foreman 3.12/Katello 4.14 (Satellite 6.16) * [ ] Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9) * [ ] Foreman 3.10/Katello 4.12 * [ ] Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10) * [ ] Foreman 3.8/Katello 4.10 * [ ] Foreman 3.7/Katello 4.9 (Satellite 6.14) * We do not accept PRs for Foreman older than 3.7.