Skip to content

Update OCM setup docs#3418

Merged
openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
rawagner:update_ocm_docs
Feb 26, 2026
Merged

Update OCM setup docs#3418
openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
rawagner:update_ocm_docs

Conversation

@rawagner
Copy link
Member

@rawagner rawagner commented Feb 26, 2026

Summary by CodeRabbit

  • Documentation
    • Simplified development setup instructions with standardized npm commands.
    • Streamlined local integration setup process by replacing multi-step procedures with direct access guidance.
    • Enhanced developer onboarding clarity.

@openshift-ci openshift-ci bot requested review from asmasarw and celdrake February 26, 2026 08:16
@openshift-ci openshift-ci bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 26, 2026
@coderabbitai
Copy link

coderabbitai bot commented Feb 26, 2026

📝 Walkthrough

Walkthrough

Documentation updates to DEVELOPMENT.md simplify local setup instructions by replacing multi-step processes with direct access guidance, standardizing npm commands (npm ci, npm run start), and removing uhc-portal cloning steps.

Changes

Cohort / File(s) Summary
Documentation Simplification
docs/DEVELOPMENT.md
Streamlined local development instructions by replacing npm install with npm ci, standardizing start command from npm run start:federated to npm run start, and removing multi-step uhc-portal fork/clone workflow in favor of direct URL access.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested labels

lgtm, size/M

Suggested reviewers

  • ammont82
  • celdrake
  • jgyselov

Poem

🐰 With nimble paws, we hop with glee,
The docs are cleaner now, you'll see!
No forking fuss, no steps so long,
Just npm ci, and we move along! 🚀

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Update OCM setup docs' directly relates to the main change, which updates documentation in docs/DEVELOPMENT.md with new setup guidance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/DEVELOPMENT.md (1)

95-95: Add prerequisite link for the direct URL path.

Line 95 is a good simplification, but this URL usually depends on assisted-installer-app local setup (hosts/certs/auth context). Add a short pointer to the relevant assisted-installer-app setup docs so first-time setup doesn’t dead-end.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/DEVELOPMENT.md` at line 95, Update the documentation line that shows the
direct URL "https://prod.foo.redhat.com:1337/openshift/assisted-installer" to
include a short prerequisite pointer to the assisted-installer-app local setup
docs; explicitly mention that hosts, certificates, and auth context must be
configured and add a concise link or reference text to the
assisted-installer-app setup guide (e.g., "see assisted-installer-app setup for
hosts/certs/auth") so first-time users know where to complete prerequisites
before visiting that URL.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/DEVELOPMENT.md`:
- Around line 84-86: The documentation note about running `yalc link` after `npm
ci` incorrectly warns only about updating `yarn.lock`; update the text around
the `yalc link` instruction to mention `package-lock.json` (and optionally both
lockfiles) instead of or in addition to `yarn.lock`, and keep the admonition to
not commit changes to `package.json` or the relevant lockfile(s); look for the
`yalc link`/`npm ci` wording and the existing `package.json`/`yarn.lock`
references to make this wording change.

---

Nitpick comments:
In `@docs/DEVELOPMENT.md`:
- Line 95: Update the documentation line that shows the direct URL
"https://prod.foo.redhat.com:1337/openshift/assisted-installer" to include a
short prerequisite pointer to the assisted-installer-app local setup docs;
explicitly mention that hosts, certificates, and auth context must be configured
and add a concise link or reference text to the assisted-installer-app setup
guide (e.g., "see assisted-installer-app setup for hosts/certs/auth") so
first-time users know where to complete prerequisites before visiting that URL.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bdf6ed3 and 40fdf80.

📒 Files selected for processing (1)
  • docs/DEVELOPMENT.md

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 26, 2026
@openshift-ci
Copy link

openshift-ci bot commented Feb 26, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ElayAharoni, rawagner

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-merge-bot openshift-merge-bot bot merged commit a2f2102 into openshift-assisted:master Feb 26, 2026
12 checks passed
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. lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants