Documentation team meeting 2024-04-18

This is just the agenda for the meeting at 15:00 - 15:30 (CEST). Join via


Follow up on last week’s issues


Anything updated within the past week can be ignored during triage. If someone wants to discuss a specific issue/PR then it should be added to the agenda.


  • General discussion about relationship between release notes and upgrades.
    • Avital: Seems obvious, but we tend to overlook the relationship between good release notes and smooth upgrades. Writers work on RNs under pressure. They feel like just another chore to get through. Downstream, we never thought about how they work as a content type.
    • Ewoud: Release notes should contain everything a user needs to know for upgrading.
    • Avital: Satellite RNs are generated with a tool. We can modify the template so that RNs are easier to navigate and grouped logically.
  • Max gave a high-level description of his process for converting Asciidoc content to Antora for Orcharhino.
    • Links and anchors are the hardest things to convert.
    • Left-hand navigation is created by Asciidoc (everything in one big assembly). Right-hand navigation and breadcrumbs are created by Antora.
    • Version picker on bottom left corner. Ewoud: Would be useful for Debian and Katello on the Foreman guide site.
  • Max asked us to review PR2792, which introduces tags for the glossary. See Tagged regions in Asciidoc documentation for details.
    • Ewoud: Would be useful instead of ‘ifeval’ for separating content.
    • Max: Has not yet been tested with downstream docs.
  • Malhar requested review for his PR for adding a RHEL attribute.

You can reach us on matrix.

Sorry, I have a schedule conflict so I won’t be able to join.

Postponed the meeting by 2 hours.

1 Like

It’s Foreman Community Demo at 4pm. See Foreman Community Demo #139

Can we meet it earlier?

1 Like

Moved to 15 PM.

1 Like