Conditionalize content in upstream Quarkus repository for the 3.8.next product release

[rolfedh]

Description

Overview

We're gearing up for the upcoming 3.8 release and its subsequent micro releases, making it crucial to start implementing conditional statements in our documentation. This initiative will ensure that the RHBQ product documentation accurately mirrors the support status of extensions, maintaining clarity and reliability for our users.

Objectives

• Immediate Implementation of Conditionals: Kick off the process of adding conditionals to the upstream documentation now to smoothly incorporate expected changes in the "3.8 next" release (that is, the first micro release post-3.8 launch).
• Post GA Release Documentation Strategy: Plan to enrich 3.8 next with comprehensive security documentation, addressing all conditional documentation needs promptly.
• Adjustments for Unsupported Extensions: Apply conditional documentation for extensions not supported in the 3.8 release, preserving documentation integrity until these can be revisited in future releases.
• Priority on Documentation Updates: Treat upstream documentation adjustments as an urgent priority to facilitate a seamless update process for new or revised extensions in upcoming versions.

Actions Needed

1. Start Conditional Documentation: Begin inserting conditional tags in the upstream documentation to tailor content visibility based on extension support status.
2. Engage for Collaboration and Review: Consult with the productization team about extensions needing documentation despite not being productized, aiming for at least tech preview status by the next release.
3. Explore Automation for Tracking: Investigate automation tools to generate accurate reports on extensions' support status, reducing manual errors and ensuring documentation alignment with product updates.

Expected Outcomes

• Documentation that faithfully represents extension support statuses, boosting user confidence and minimizing confusion.
• Efficient documentation updates in sync with product releases, enabled by the strategic use of conditional content and automation.

Request for Input

Your insights and suggestions are critical to the success of this initiative. Please share your thoughts below or contact me directly for a more in-depth conversation.

Appreciate your collaboration and support on this essential project.

Best,
Rolfe

Implementation ideas

No response

[quarkus-bot]

/cc @MichalMaler (documentation), @ebullient (documentation), @inoxx03 (documentation), @michelle-purcell (documentation), @sheilamjones (documentation), @sunayna15 (documentation)