Add compatibility matrix

[jmagak]

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s): 1.4

Add the relevant labels to the Pull Request.
Issue: https://issues.redhat.com/browse/RHIDP-5070

[rhdh-bot]

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-875/ @ 01/28/25 15:55:26

[nickboldt]

Looks OK now at https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-875/rel-notes-rhdh/#compatibility-matrix

Though that first column is sorta redundant now as we're only talking about the current release version, rather than listing multiple versions.

You could replace the need to maintain this table entiurely with a link to the Supported Platforms table at https://access.redhat.com/support/policy/updates/developerhub

But if @reestr and @christophe-f are happy with this duplication, then so am I.

[linfraze]

I like the idea of linking to the the Supported Platforms table as the single source of truth, as @nickboldt suggested. Then we don't have to worry about duplicating existing information, maintaining multiple sources, or staying in sync. But if there is a reason why it makes sense to embed the duplicate info directly in the RNs, then we can do the needful.

[Gerry-Forde]

I can see the importance of displaying the compatibility details prominently in the Release Notes for each release but would either linking to the Supported Platforms page or just having a bulleted list of platforms look better than the table which seems overkill to me with just one row containing multiple data fields?

[Gerry-Forde]

@jmagak For some reason, this link to the Compatibility Matrix links to a PR, can you review this please:

[nickboldt]

having a bulleted list of platforms

... which you would then have to update every quarter if new platforms/versions are added.

https://access.redhat.com/support/policy/updates/developerhub is already a list... inside a table.

@Gerry-Forde in your screenshot above, where does the link for the Compatibility Matrix go? If we're talking about replacing that page with a link to https://access.redhat.com/support/policy/updates/developerhub then "Additional Resources" becomes a page with the same link on it. Why make people click several times for the same information?

[hmanwani-rh]

@jmagak I’ve added a few minor comments. However, I recall that we planned to include a table for the supported versions in the release notes. For example, the 1.5 release notes would exclude version 1.3 and only include 1.5 and 1.4, which I think we can maintain indicating the relevant supported versions in a release. Additionally, how about we share the lifecycle page link in the "Additional Resources" section, similar to how it’s done in the "Supported Platforms" section?

Let me know your thoughts!

[jmagak]

@jmagak For some reason, this link to the Compatibility Matrix links to a PR, can you review this please:

@Gerry-Forde I have removed the link. It was intended to direct users to the Compatibility Matrix in the Release Notes for RHDH 1.4. Please assist me in reviewing the PR for the same.

[nickboldt]

Let me know your thoughts!

My $0.02 cents remains "why duplicate content when you can just link to the lifecycle page as the single source of truth?"

Also having 1.3 content in the 1.4 guide ... what value does that provide? is the idea to provide people with immediate access to seeing what has changed between 1.3 and 1.4 in terms of supported platforms/versions? If so that is again already in the lifecyle doc.

[hmanwani-rh]

Let me know your thoughts!

My $0.02 cents remains "why duplicate content when you can just link to the lifecycle page as the single source of truth?"

Also having 1.3 content in the 1.4 guide ... what value does that provide? is the idea to provide people with immediate access to seeing what has changed between 1.3 and 1.4 in terms of supported platforms/versions? If so that is again already in the lifecyle doc.

@nickboldt The Lifecycle page currently doesn’t include the compatible Backstage versions, which I think would be helpful to show in our documentation. What are your thoughts on this?
Additionally, we may also need to include the tested hyperscaler versions.

[nickboldt]

Backstage version is already documented in https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/blob/release-1.4/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc

If you want to make it more obvious, how about this change to the copy so that the reader doesn't have to read "Developer Hub" 4 times (only twice) ?

#886

right above the matrix table :D

[nickboldt]

we may also need to include the tested hyperscaler versions

Sounds like something to add for 1.5. We don't have it for 1.2-1.4, so why not add this New Feature in the upcoming release instead of the maintenance ones?

[jmagak]

Instead of a Compatibility Matrix, we are adding an Additional Resources section that directs users to the lifecycle page. Hence, we are closing this PR.