CONSOLE-5271: Address docs review feedback from PR #16551#16655
CONSOLE-5271: Address docs review feedback from PR #16551#16655perdasilva wants to merge 1 commit into
Conversation
|
@perdasilva: This pull request references CONSOLE-5271 which is a valid jira issue. DetailsIn response to this:
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. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: openshift/coderabbit/.coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (2)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughFrontend 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. ChangesMessaging and Lifecycle Terminology Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 14 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (14 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: perdasilva The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
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>
996ad9d to
7c7a9ac
Compare
|
@perdasilva: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
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:
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."
"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").
"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.
"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.
Backend error messages (comment, comment):
Screenshots / screen recording:
Test setup:
Requires a cluster with the
OPERATOR_LIFECYCLE_METADATAfeature flag enabled and operators with lifecycle metadata available via the OLM lifecycle API.Test cases:
Browser conformance:
Additional info:
Addresses all docs review comments from @jseseCCS on #16551.
Summary by CodeRabbit