docs: Finish infra-controller rename accuracy pass#3097
Open
kfelternv wants to merge 5 commits into
Open
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
Summary by CodeRabbit
WalkthroughThis PR updates documentation across deploy/README.md, docs/getting-started/quick-start.md, helm-prereqs/README.md and setup.sh, rest-api/CHANGELOG.md, and rest-api/deploy/INSTALLATION.md. Changes align NICo branding, correct environment variable requirements per skip flags, document the new NICo Flow phase and --skip-flow option, and repoint stale documentation links. ChangesQuick-start and prerequisites accuracy pass
rest-api documentation link repointing
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Related issues: Suggested labels: documentation Suggested reviewers: None specified 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
kfelternv
changed the title
kfelternv
requested review from
a team,
polarweasel and
shayan1995
as code owners
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3097.docs.buildwithfern.com/infra-controller |
🔐 TruffleHog Secret Scan✅ No secrets or credentials found! Your code has been scanned for 700+ types of secrets and credentials. All clear! 🎉 🕐 Last updated: 2026-07-07 16:29:12 UTC | Commit: 9801a94 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/getting-started/quick-start.md`:
- Around line 75-100: The quick-start docs still reference the stale Core image
path in the NICO_IMAGE_REGISTRY description, which conflicts with the current
nico-core naming used elsewhere. Update the copy in this section so the Core
image repository path matches the naming used by deploy/README.md and
helm-prereqs/setup.sh, and keep the examples and table entries consistent with
that corrected path.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: feddf27a-3af4-4a5c-a773-11c681c96d62
📒 Files selected for processing (6)
deploy/README.mddocs/getting-started/quick-start.mdhelm-prereqs/README.mdhelm-prereqs/setup.shrest-api/CHANGELOG.mdrest-api/deploy/INSTALLATION.md
🔍 Container Scan Summary
Per-CVE detail lives in the per-service |
thossain-nv
approved these changes
Jul 7, 2026
thossain-nv
left a comment
thossain-nv
left a comment
Contributor
There was a problem hiding this comment.
Thanks for the fixes @kfelternv, one suggestion.
Signed-off-by: Kyle Felter <kfelter@nvidia.com>
Signed-off-by: Kyle Felter <kfelter@nvidia.com>
thossain-nv
approved these changes
Jul 7, 2026
thossain-nv
approved these changes
Jul 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
helm-prereqs/setup.shNICO_TAGpath accurately as the NICo Core (nico-core) image and remove the remainingnvmetal-nicoMarkdown referencesWhy
The repository rename work in #2357 fixed part of the documentation, but later setup changes left the operator path inconsistent. The Quick Start stopped at Phase 7h without documenting Flow, the site-agent, the current setup flags, or the actual conditional environment requirements. Historical changelog links also continued to point to the old GitHub Pages reference.
This change synchronizes the operator documentation with the current scripts and maps each old API link to its specific maintained destination.
Related issues
Closes #2358
Type of Change
Breaking Changes
Testing
Verified against upstream
mainat8dc207ab25d8aec3001449ab1b5ea440977f05f0:git diff --check— passbash -n helm-prereqs/setup.sh— passmake -n images-core IMAGE_REGISTRY=registry.example/nico IMAGE_TAG=verify VERSION=verify CI_COMMIT_SHORT_SHA=verify— continues to emit the deliberately renamed local imageregistry.example/nico/nico:verifydeploy/kustomization.yamlmaps the Core placeholder toNICO_REGISTRY_PATH/nico-corewithNICO_TAG, matching the updated README wordingsetup.shand the Quick Startinfra-controller-coreprose, malformed auth URLs, ornvmetal-nicoMarkdown referencesllms.txtindex and return HTTP 200; the corrected auth URL also returns HTTP 200rumdldiagnostics across the four primary issue files decrease from 32 onmainto 27; no new diagnostics occur on edited linesAdditional Notes
make imagesproducesnico, kustomize usesnico-core, and the currently published Helm/setup artifact remainsnvmetal-carbide.ncx-serviceKeycloak client and/org/ncx/API examples were intentionally preserved because they still match the implementation./ok-to-testcopy workflow before checks run.