RHIDP-5070-Update supported platforms #833
Conversation
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-833/ @ 01/08/25 17:40:39 |
jmagak
force-pushed
the
RHIDP-5070-Supported-platforms
branch
from
301dad3 to
02b4441
Compare
jmagak
force-pushed
the
RHIDP-5070-Supported-platforms
branch
from
ace34fb to
b98c570
Compare
| {product} runs on {ocp-short} {ocp-version-min}-{ocp-version} on supported architectures and providers, such as: | ||
|
|
||
| * link:{installing-on-ocp-book-url}[{ocp-brand-name} {ocp-version-min}-{ocp-version}] | ||
| * link:{installing-on-eks-book-url}[{eks-brand-name}] | ||
| * link:{installing-on-aks-book-url}[{aks-brand-name}] | ||
| * link:{installing-on-osd-on-gcp-book-url}[{gcp-brand-name}] | ||
| * link:{installing-on-gke-book-url}[{gke-brand-name}] | ||
| You can find the supported features and life cycle dates for both current and past versions of {product} on the link:https://access.redhat.com/support/policy/updates/developerhub[Life Cycle page]. |
There was a problem hiding this comment.
@christophe-f @Gerry-Forde are we getting rid of these Install guides? Or just making them harder to find by not linking them from the About guide?
See also https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/pull/835/files
There was a problem hiding this comment.
are we getting rid of these Install guides?
We are not getting rid of the install guides for sure.
Are we replacing this content with a link to a single source of truth - the support doc, to reduce end user confusion?
Yes, we are.
Please note that the support level for GKE - [Dev Preview] Google Kubernetes Engine (Google GKE) is precisely mentioned in the support doc, where as this has not been reproduced in the docs for any of the RHDH versions.
For example this is how the Serverless docs do this
Since we are talking about supported platforms here, capturing a list of the platforms with the level of support is crucial.
If we as a team decide to take the responsibility of updating this section with the corrections you made in your PR every release I have no objections to adding the bulleted list of platforms here, in addition.
Or just making them harder to find by not linking them from the About guide?
Those links provide absolutely no clue to the end user that they are taking you to the Install guides. I had expected those links to go to the OCP/K8 flavor docs.
Including these links in the About section sounds good to me but having them linked in the supported platforms section does not make sense to me. I would suggest creating a 'Next Steps' section towards the end of the About section like we do the Additional Resources section and add these links with more intuitive anchor text on the lines of - Installing RHDH on (add name of the K8 platform).
There was a problem hiding this comment.
I'm fine with that.
Can we replace 'supported features' for 'supported platforms'?
| {product} runs on {ocp-short} {ocp-version-min}-{ocp-version} on supported architectures and providers, such as: | ||
|
|
||
| * link:{installing-on-ocp-book-url}[{ocp-brand-name} {ocp-version-min}-{ocp-version}] | ||
| * link:{installing-on-eks-book-url}[{eks-brand-name}] | ||
| * link:{installing-on-aks-book-url}[{aks-brand-name}] | ||
| * link:{installing-on-osd-on-gcp-book-url}[{gcp-brand-name}] | ||
| * link:{installing-on-gke-book-url}[{gke-brand-name}] | ||
| You can find the supported features and life cycle dates for both current and past versions of {product} on the link:https://access.redhat.com/support/policy/updates/developerhub[Life Cycle page]. |
There was a problem hiding this comment.
I'm fine with that.
Can we replace 'supported features' for 'supported platforms'?
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s): 1.4
Add the relevant labels to the Pull Request.
Issue: RHIDP-5070