Skip to content

ROX-33550: Add doc links for operator install and deprecation notices#19554

Open
sachaudh wants to merge 4 commits intomasterfrom
ROX-33550/ui-doc-links-operator-deprecation
Open

ROX-33550: Add doc links for operator install and deprecation notices#19554
sachaudh wants to merge 4 commits intomasterfrom
ROX-33550/ui-doc-links-operator-deprecation

Conversation

@sachaudh
Copy link
Copy Markdown
Contributor

@sachaudh sachaudh commented Mar 23, 2026 •
edited
Loading

Summary

  • Adds non-OpenShift documentation links to the operator installation instructions page (SecureClusterUsingOperator.tsx), resolving the TODO ROX-33550 comment left by ROX-33119
  • Adds a link to operator installation documentation inside all three deprecation warning alerts (Init Bundles Helm, CRS Helm, legacy manifest) so users can find migration guidance

Changes

File Change
InitBundles/SecureClusterUsingOperator.tsx Remove TODO, add "other platforms" doc links
InitBundles/SecureClusterUsingHelmChart.tsx Add operator doc link in deprecation alert
CRS/SecureClusterUsingHelmChart.tsx Add operator doc link in deprecation alert
ClusterDeployment.tsx Add operator doc link in deprecation alert

Test plan

  • Verify operator instruction page shows 4 doc links (2 OpenShift + 2 other platforms)
  • Verify each deprecation alert contains a clickable "operator installation documentation" link
  • Verify all doc links open in new tabs and point to valid docs.redhat.com pages
  • Verify no visual regressions in the deprecation alert layout

Screenshots

Screenshot 2026-03-23 at 4 04 20 PM Screenshot 2026-03-23 at 4 04 53 PM Screenshot 2026-03-23 at 4 05 20 PM Screenshot 2026-03-23 at 4 06 46 PM

@openshift-ci
Copy link
Copy Markdown

openshift-ci bot commented Mar 23, 2026

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@rhacs-bot
Copy link
Copy Markdown
Contributor

rhacs-bot commented Mar 23, 2026 •
edited
Loading

Images are ready for the commit at a455f7e.

To use with deploy scripts, first export MAIN_IMAGE_TAG=4.11.x-458-ga455f7e28a.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 23, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 49.32%. Comparing base (9aaae09) to head (a455f7e).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master   #19554      +/-   ##
==========================================
- Coverage   49.32%   49.32%   -0.01%     
==========================================
  Files        2737     2737              
  Lines      206445   206445              
==========================================
- Hits       101837   101829       -8     
- Misses      97065    97070       +5     
- Partials     7543     7546       +3
Flag Coverage Δ
go-unit-tests 49.32% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@sachaudh sachaudh requested a review from porridge March 23, 2026 20:58
porridge
porridge approved these changes Mar 25, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@porridge porridge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but I agree a platform-agnostic operator install doc landing page would be better.

@sachaudh sachaudh force-pushed the ROX-33125/helm-manifest-deprecation-notices branch from 26a7a02 to 22703ad Compare March 25, 2026 16:30
@sachaudh sachaudh force-pushed the ROX-33550/ui-doc-links-operator-deprecation branch from 8d1711c to b1b2338 Compare March 25, 2026 17:05
sachaudh
sachaudh commented Mar 25, 2026
View reviewed changes
ui/apps/platform/src/Containers/Clusters/Components/InstallMethodDeprecationAlert.tsx
<a
href={getVersionedDocs(
version,
'installing/installing-rhacs-on-red-hat-openshift#install-secured-cluster-ocp'
Copy link
Copy Markdown
Contributor Author

@sachaudh sachaudh Mar 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kcarmichael08 We’ve added doc links to the deprecation notices on the Helm and manifest install pages. Each deprecation alert now links to "operator installation documentation" so users have a clear migration path.

Currently, the link points to the OpenShift operator install page (installing-rhacs-on-red-hat-openshift#install-secured-cluster-ocp). Two questions:

  1. Is there a platform-agnostic operator install page we should link to instead?
  2. If not, should we show two links (one for OpenShift, one for other platforms) rather than just the OpenShift one?

Copy link
Copy Markdown
Contributor

@kcarmichael08 kcarmichael08 Mar 25, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. No, there is no Operator install for non-OCP since that feature isn't available yet.
  2. I hesitate to put in narrowly-targeted hardcoded links (even if we could guess what the link structure would be) because we will be changing our whole publishing system in summer 2026 so any links would need to be changed again. We can put in redirects, but the fewer ones that we have to redirect, the better.

For now, I think linking to OCP Operator installation docs is OK.

Copy link
Copy Markdown
Contributor

@porridge porridge Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. No, there is no Operator install for non-OCP since that feature isn't available yet.

Well, I think at this point it's available enough to be documentable. See this ticket.

Copy link
Copy Markdown
Contributor

@kcarmichael08 kcarmichael08 Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but that ticket was created two days ago, so there is no documentation available yet to add a link for in the GUI. So I cannot provide a link to documentation that is not yet created.

The parent ticket of ROX-33749 is a 4.11 ticket, so it would typically be done in the 4.11 cycle (which has not yet started for docs - as you know, our work lags behind development). When you say "enough to be documentable," were you expecting something now, before 4.11 docs are published?

Copy link
Copy Markdown
Contributor Author

@sachaudh sachaudh Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense, Kerry. I don't think the intention of this PR is to assume that the docs are already in place. Just setting things up so that when the docs come in, we already have everything set up on the UI. If the external link still needs to be decided, we can either leave a comment in JIRA to revisit this and update the link or keep this open until that is decided.

Copy link
Copy Markdown
Contributor

@kcarmichael08 kcarmichael08 Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea! We should have a better idea of the link after the drafts are done.

@sachaudh sachaudh requested a review from kcarmichael08 March 25, 2026 17:09
@sachaudh sachaudh marked this pull request as ready for review March 25, 2026 17:09
@sachaudh sachaudh requested a review from a team as a code owner March 25, 2026 17:09
@kcarmichael08
Copy link
Copy Markdown
Contributor

kcarmichael08 commented Mar 26, 2026

LGTM but I agree a platform-agnostic operator install doc landing page would be better.

Until those docs are created and published, we can't provide a link.

You could link to the overall "installation page" instead, which is not as targeted, but would at least get users to the correct overall page and they can scroll, look through the TOC, or search in the page to look for the Operator for Kubernetes system instructions when they are published.

Base automatically changed from ROX-33125/helm-manifest-deprecation-notices to master March 26, 2026 16:01
sachaudh added 4 commits March 26, 2026 09:02
@sachaudh
feat(clusters): add doc links for operator install and deprecation no…
449344a 
…tices

Add non-OpenShift documentation links to the operator installation
instructions page and link deprecation alerts to operator install docs
so users can easily find migration guidance.

Signed-off-by: Saif Chaudhry <schaudhr@redhat.com>
@sachaudh
refactor(clusters): extract InstallMethodDeprecationAlert component
f5476b5 
Deduplicate the identical deprecation alert block that was repeated
across three cluster installation pages into a shared component.

Signed-off-by: Saif Chaudhry <schaudhr@redhat.com>
@sachaudh
fix: version
52b163a
@sachaudh
fix(clusters): resolve prettier formatting in deprecation message
a455f7e 
Line exceeded print width in SecureClusterUsingHelmChart.

Signed-off-by: Saif Chaudhry <schaudhr@redhat.com>
@sachaudh sachaudh force-pushed the ROX-33550/ui-doc-links-operator-deprecation branch from 3e11d5c to a455f7e Compare March 26, 2026 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@porridge porridge porridge approved these changes

@kcarmichael08 kcarmichael08 Awaiting requested review from kcarmichael08

Assignees

No one assigned

Labels

area/ui

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@sachaudh @rhacs-bot @kcarmichael08 @porridge