Skip to content

CONSOLE-5271: Address docs review feedback from PR #16551#16655

Open
perdasilva wants to merge 1 commit into
openshift:mainfrom
perdasilva:CONSOLE-5271-address-review-comments
Open

CONSOLE-5271: Address docs review feedback from PR #16551#16655
perdasilva wants to merge 1 commit into
openshift:mainfrom
perdasilva:CONSOLE-5271-address-review-comments

Conversation

@perdasilva

@perdasilva perdasilva commented Jun 19, 2026

Copy link
Copy Markdown

Analysis / Root cause:
Docs review feedback from jseseCCS on PR #16551 identified microcopy and consistency issues in the operator lifecycle UI strings and backend error messages.

Solution description:
Addresses all inline review comments from @jseseCCS on #16551:

  1. SKU disclaimer (comment): Changed "May" → "This might" (possibility, not permission), removed "your actual SKU" repetition, clarified action → "This might not reflect your actual SKU. Check your subscription for extended support options."

  2. "life cycle" vs "lifecycle" (comment, comment, comment): Standardized link text from "life cycle"/"life cycles" to "lifecycle"/"lifecycles" to match "Lifecycle dates" and OLM naming convention ("Operator Lifecycle Manager").

  3. "Cluster compatibility" casing (comment): Intentionally sentence case — it's a table column header, not a proper noun like "Provided APIs" or "Installed Operators" which are product-defined terms. No change needed.

  4. "Support phase" vs "Support" (comment, comment): These are different concepts — "Support phase" is the lifecycle table column showing the current support phase (Full support, Maintenance, etc.), while "Support" is the CSV detail page field linking to the vendor's support workflow URL. No change needed.

  5. Backend error messages (comment, comment):

    • "Failed to connect to the catalog source." → "Could not connect to the catalog source."
    • "Lifecycle metadata is not available for this catalog." → "The lifecycle metadata is unavailable for this catalog."

Screenshots / screen recording:

Test setup:
Requires a cluster with the OPERATOR_LIFECYCLE_METADATA feature flag enabled and operators with lifecycle metadata available via the OLM lifecycle API.

Test cases:

  • Verify the lifecycle popover footer shows the updated SKU disclaimer text
  • Verify lifecycle popover footer links use "lifecycle" (one word)
  • Verify backend error messages use updated phrasing
  • All 26 frontend unit tests and backend OLM tests passing

Browser conformance:

  • Chrome
  • Firefox
  • Safari (or Epiphany on Linux)

Additional info:
Addresses all docs review comments from @jseseCCS on #16551.

Summary by CodeRabbit

  • Documentation
    • Improved warning message clarity regarding SKU and subscription information
    • Updated error response text for catalog source connectivity and metadata availability
    • Standardized lifecycle terminology throughout the interface

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 19, 2026
@openshift-ci-robot

openshift-ci-robot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

@perdasilva: This pull request references CONSOLE-5271 which is a valid jira issue.

Details

In response to this:

Analysis / Root cause:
Docs review feedback from jseseCCS on PR #16551 identified microcopy issues in the SKU disclaimer text in the operator lifecycle popover footer.

Solution description:
Revised the SKU disclaimer text per docs review feedback:

  • Changed "May" → "This might" (possibility, not permission)
  • Removed repetition of "your actual SKU" across both sentences
  • Clarified the action: "Check your subscription for extended support options"

Before: "May not reflect your actual SKU. Check your actual SKU for extended support."
After: "This might not reflect your actual SKU. Check your subscription for extended support options."

Screenshots / screen recording:

Test setup:
Requires a cluster with the OPERATOR_LIFECYCLE_METADATA feature flag enabled and operators with lifecycle metadata available via the OLM lifecycle API.

Test cases:

  • Verify the lifecycle popover footer shows the updated SKU disclaimer text
  • Verify i18n key matches the updated string

Browser conformance:

  • Chrome
  • Firefox
  • Safari (or Epiphany on Linux)

Additional info:
Addresses docs review comment from @jseseCCS on #16551: #16551 (comment)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 9b0752c7-4e80-4f7b-ab7a-42005494e2a0

📥 Commits

Reviewing files that changed from the base of the PR and between 024f2ea and 7c7a9ac.

📒 Files selected for processing (3)
  • frontend/packages/operator-lifecycle-manager/locales/en/olm.json
  • frontend/packages/operator-lifecycle-manager/src/components/operator-lifecycle-status.tsx
  • pkg/olm/lifecycle.go
✅ Files skipped from review due to trivial changes (2)
  • pkg/olm/lifecycle.go
  • frontend/packages/operator-lifecycle-manager/src/components/operator-lifecycle-status.tsx
🚧 Files skipped from review as they are similar to previous changes (1)
  • frontend/packages/operator-lifecycle-manager/locales/en/olm.json

Walkthrough

Frontend locale strings are updated to revise the SKU warning copy to mention subscription and extended support options, and lifecycle terminology is normalized to remove spaces. Backend error messages in the catalog service are clarified for connection failures and metadata unavailability. Component references to locale strings are aligned.

Changes

Messaging and Lifecycle Terminology Updates

Layer / File(s) Summary
Frontend footer and lifecycle terminology
frontend/packages/operator-lifecycle-manager/locales/en/olm.json, frontend/packages/operator-lifecycle-manager/src/components/operator-lifecycle-status.tsx
Locale strings updated: SKU warning now reads "This might not reflect your actual SKU. Check your subscription for extended support options"; lifecycle terminology normalized from "life cycle(s)" to "lifecycle(s)" in three locale keys. LifecycleDatesFooter component updated to reference the revised locale entries for the warning and external link labels.
Backend error messages
pkg/olm/lifecycle.go
Error response messages clarified: CatalogSource connection error changed to "Could not connect to the catalog source"; metadata unavailability message changed to "The lifecycle metadata is unavailable for this catalog".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 14 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (14 passed)
Check name Status Explanation
Title check ✅ Passed The title 'CONSOLE-5271: Address docs review feedback from PR #16551' is directly related to the changeset, which implements feedback from a previous PR review.
Description check ✅ Passed The PR description is comprehensive and well-structured, covering analysis/root cause, detailed solution description with specific citations, test setup, and test cases.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed This PR modifies only source files (locales, React components, and Go backend), not test files. The repository uses Jest (frontend) and standard Go testing (backend), not Ginkgo. The check is not a...
Test Structure And Quality ✅ Passed This PR contains only text/copy changes (locale strings, UI text, error messages). No test code or Ginkgo tests were modified, making the custom check not applicable to this PR.
Microshift Test Compatibility ✅ Passed This PR contains no new Ginkgo e2e tests. Changes are limited to locale strings (JSON), React component text, and backend error messages—the custom check is not applicable.
Single Node Openshift (Sno) Test Compatibility ✅ Passed This PR does not add any new Ginkgo e2e tests. It only modifies locale strings, a React component, and backend error messages. The SNO compatibility check is not applicable.
Topology-Aware Scheduling Compatibility ✅ Passed PR contains only text/string/error message changes (localization, UI copy, backend error messages) with no deployment manifests, operator code, or controllers that could introduce scheduling constr...
Ote Binary Stdout Contract ✅ Passed PR changes are text-only (locale strings and error messages). Error messages sent via HTTP ResponseWriter, not stdout. No fmt.Print/log.Print or process-level stdout writes introduced.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed No Ginkgo e2e tests added in this PR. Changes are to locale JSON, React component, and Go backend source files only.
No-Weak-Crypto ✅ Passed PR contains only text/microcopy updates with no cryptographic code. No weak crypto algorithms (MD5, SHA1, DES, RC4, 3DES, Blowfish, ECB), custom crypto implementations, or improper secret compariso...
Container-Privileges ✅ Passed PR contains only UI text and error message changes in locale files, React components, and Go code—no container/K8s manifests or container privilege configurations present.
No-Sensitive-Data-In-Logs ✅ Passed No logging that exposes passwords, tokens, API keys, PII, session IDs, internal hostnames, or customer data was added; changes are text/UI updates and error message rewording only.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@openshift-ci openshift-ci Bot requested review from Leo6Leo and cajieh June 19, 2026 13:08
@openshift-ci openshift-ci Bot added component/olm Related to OLM kind/i18n Indicates issue or PR relates to internationalization or has content that needs to be translated component/backend Related to backend labels Jun 19, 2026
@openshift-ci

openshift-ci Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: perdasilva
Once this PR has been reviewed and has the lgtm label, please assign jhadvig for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Addresses all inline review comments from jseseCCS:

- Revise SKU disclaimer: "May not reflect your actual SKU. Check your
  actual SKU for extended support." → "This might not reflect your
  actual SKU. Check your subscription for extended support options."
  (use "might" for possibility, remove repetition, clarify action)
- Standardize "life cycle"/"life cycles" to "lifecycle"/"lifecycles"
  to match "Lifecycle dates" and OLM naming ("Operator Lifecycle Manager")
- Revise error: "Failed to connect" → "Could not connect to the
  catalog source."
- Revise error: "Lifecycle metadata is not available" → "The lifecycle
  metadata is unavailable for this catalog."

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@perdasilva perdasilva changed the title CONSOLE-5271: Revise SKU disclaimer microcopy per docs review CONSOLE-5271: Address docs review feedback from PR #16551 Jun 19, 2026
@perdasilva perdasilva force-pushed the CONSOLE-5271-address-review-comments branch from 996ad9d to 7c7a9ac Compare June 19, 2026 14:27
@openshift-ci

openshift-ci Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

@perdasilva: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/backend Related to backend component/olm Related to OLM jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. kind/i18n Indicates issue or PR relates to internationalization or has content that needs to be translated

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants