Feature Overview (mandatory - Complete while in New status)

This feature request was a result of multiple documentation bugs (linked) that reported lack of public-facing documentation that maps operator versions on the OpenShift OperatorHub and RHOSO versions.

Goals (mandatory - Complete while in New status)

Following a discussion with RelDel jjoyce@redhat.com , it seems that there is already an internal Confluence page that RelDel maintains for this mapping that we could use as a source for this content:

https://spaces.redhat.com/display/PRODCHAIN/OSP+18.0+Operator+Version+Mappings

The docs team policy is to not keep specific versioning information in the official docs, so the proposed direction is to create a KB article and update it regularly.

Requirements (mandatory -_ Complete while in Refinement status):

Links to the KB article can be added to the official docs in the following locations:

• Release Notes - New and enhanced features (prerequisite) https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html-single/release_notes/index#chap-top-new-features_release-notes
• Planning guide - Operators overview (for more information) https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html-single/planning_your_deployment/index#con_rhoso-service-Operators_rhoso-overview
• Deployment guide - Operator installation (prerequisite) https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html-single/deploying_red_hat_openstack_services_on_openshift/index#assembly_installing-and-preparing-the-Operators
• Adoption guide - Prerequisites (ensure version) https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html-single/adopting_a_red_hat_openstack_platform_17.1_deployment/index#adoption-prerequisites_planning
• Minor updates guide - Prerequisite (ensure version) https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html-single/updating_your_environment_to_the_latest_maintenance_release/index#con_minor-update-preparation-checklist_preparing-minor-update
• https://access.redhat.com/support/policy/updates/openstack/platform

Done - Acceptance Criteria (mandatory - Complete while in Refinement status):

• Internal Confluence page is reworked to be more compatible with scraping/exporting the content to a KB article (collaborate with RelDel)
• KB article is updated, published, and linked from official docs (docs team will own the KB article, and RelDel will continue to own the Confluence page)
• Stretch (nice-to-have): Since this information must be updated with each container upgrade and for each bugfix or feature release, we might want to find an automated/scripted way to scrape the Confluence page and copy the information to the KB article. This Done is more likely to get descoped pending refinement results.

Out of Scope {}{}(Initial completion while in Refinement status):

• Official docs must not contain the version mapping table directly, per team policy
• Stretch - In case of capacity or technical complexity issues, the automation/scripted solution for scraping the updated content might get descoped or deferred

Team Sign Off (Completion while in Planning status)

• All required Epics (known at the time) are linked to the this Feature
• All required Stories, Tasks (known at the time) for the most immediate Epics have been created and estimated
• Add - Reviewers name, Team Name
• Acceptance == Feature as “Ready” - well understood and scope is clear - Acceptance Criteria (scope) is elaborated, well defined, and understood
• Note: Only set FixVersion/s: on a Feature if the delivery team agrees they have the capacity and have committed that capability for that milestone

  Reviewed By	Team Name	Accepted	Notes
  jjoyce@redhat.com	RelDel	Yes	SME contact