Update OCM setup docs#3418
Update OCM setup docs#3418openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
Conversation
📝 WalkthroughWalkthroughDocumentation 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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.
|
[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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
a2f2102
into
openshift-assisted:master
Summary by CodeRabbit