Skip to content

SSCSI-235: Move quickstart guides to OLM bundle - #95

Merged
openshift-merge-bot[bot] merged 1 commit into
openshift:mainfrom
chiragkyal:olm-quickstart
Dec 3, 2025
Merged

SSCSI-235: Move quickstart guides to OLM bundle#95
openshift-merge-bot[bot] merged 1 commit into
openshift:mainfrom
chiragkyal:olm-quickstart

Conversation

@chiragkyal

@chiragkyal chiragkyal commented Nov 25, 2025

Copy link
Copy Markdown
Member

Follow up #94

Move quickstart guides to OLM bundle (except Operator Installation)

/cc @mytreya-rh

@openshift-ci
openshift-ci Bot requested a review from mytreya-rh November 25, 2025 14:40
@coderabbitai

coderabbitai Bot commented Nov 25, 2025

Copy link
Copy Markdown

Walkthrough

Removed a README block and one ConsoleQuickStart manifest; updated annotations and minor text in another ConsoleQuickStart manifest.

Changes

Cohort / File(s) Summary
Documentation removal
demo/console/README.md
Deleted the QuickStarts descriptive block that explained the directory purpose, installation example, and illustrative code fence.
QuickStart manifest deletion
demo/console/quick-start/secrets-store-csi/sscsi-install-quickstart.yaml
Removed the entire ConsoleQuickStart resource secrets-store-csi-install (metadata, spec, steps, embedded manifests, verification and review content).
Manifest annotation and copy edits
config/manifests/stable/sscsi-example-quickstart.yaml
Added metadata.annotations: capability.openshift.io/name: "Console", include.release.openshift.io/ibm-cloud-managed: "true", include.release.openshift.io/self-managed-high-availability: "true", include.release.openshift.io/single-node-developer: "true"; adjusted navigation wording to reference "Ecosystem" and fixed a small wording typo.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Confirm there are no remaining references or links to the deleted QuickStart in docs or manifests.
  • Verify annotation keys/values match release tooling expectations and are intended for this resource.
  • Validate the wording change and ensure localization or other QuickStart consumers are unaffected.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 4994126 and ff9dc89.

📒 Files selected for processing (3)
  • config/manifests/stable/sscsi-example-quickstart.yaml (3 hunks)
  • demo/console/README.md (0 hunks)
  • demo/console/quick-start/secrets-store-csi/sscsi-install-quickstart.yaml (0 hunks)
💤 Files with no reviewable changes (2)
  • demo/console/quick-start/secrets-store-csi/sscsi-install-quickstart.yaml
  • demo/console/README.md
🧰 Additional context used
📓 Path-based instructions (1)
**

⚙️ CodeRabbit configuration file

-Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity.

Files:

  • config/manifests/stable/sscsi-example-quickstart.yaml
🔇 Additional comments (3)
config/manifests/stable/sscsi-example-quickstart.yaml (3)

5-9: Annotations enable multi-deployment visibility — LGTM.

The added annotations appropriately target this QuickStart across IBM Cloud Managed, self-managed high-availability, and single-node developer deployments, aligning with the goal of including this in the OLM bundle. The capability.openshift.io/name: Console annotation correctly identifies this as a Console capability.


42-42: Verify the Ecosystem navigation path is correct.

The navigation guidance changed from the "Operators" section to the "Ecosystem" section. Please confirm that [Ecosystem]{{highlight qs-nav-ecosystem}} is the correct navigation reference for accessing "Installed Operators" in the current OpenShift Console structure. If users cannot locate the Installed Operators page following this path, the QuickStart task cannot be completed.


76-76: Typo fixed — improves documentation clarity.

Changed "prosessing" to "possessing," which corrects the grammar and improves clarity in the SecretProviderClass creation instructions.


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

@openshift-ci

openshift-ci Bot commented Nov 25, 2025

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chiragkyal

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

The pull request process is described 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

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 25, 2025
@chiragkyal chiragkyal changed the title Move quickstart guides to OLM bundle SSCSI-235: Move quickstart guides to OLM bundle Nov 25, 2025
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Nov 25, 2025
@openshift-ci-robot

openshift-ci-robot commented Nov 25, 2025

Copy link
Copy Markdown

@chiragkyal: This pull request references SSCSI-235 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.21.0" version, but no target version was set.

Details

In response to this:

/cc @mytreya-rh

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.

@openshift-ci-robot

openshift-ci-robot commented Nov 25, 2025

Copy link
Copy Markdown

@chiragkyal: This pull request references SSCSI-235 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.21.0" version, but no target version was set.

Details

In response to this:

Follow up #94

Move quickstart guides to OLM bundle (except Operator Installation)

/cc @mytreya-rh

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.

@mytreya-rh

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Nov 26, 2025
@chiragkyal

Copy link
Copy Markdown
Member Author

/retest

@openshift-ci openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Nov 28, 2025
@mytreya-rh

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Nov 28, 2025
Signed-off-by: chiragkyal <ckyal@redhat.com>
@openshift-ci openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Nov 28, 2025
@openshift-ci

openshift-ci Bot commented Nov 28, 2025

Copy link
Copy Markdown
Contributor

@chiragkyal: 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.

@emmajiafan

Copy link
Copy Markdown

/verified by pass

@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Dec 1, 2025
@openshift-ci-robot

Copy link
Copy Markdown

@emmajiafan: This PR has been marked as verified by pass.

Details

In response to this:

/verified by pass

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.

@mytreya-rh

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Dec 3, 2025
@openshift-merge-bot
openshift-merge-bot Bot merged commit 10398b0 into openshift:main Dec 3, 2025
14 checks passed
@chiragkyal
chiragkyal deleted the olm-quickstart branch July 6, 2026 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. verified Signifies that the PR passed pre-merge verification criteria

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants