Skip to content

Update nicocli site list validation step in documentation#3264

Open
schmaustech wants to merge 1 commit into
NVIDIA:mainfrom
schmaustech:docs/update-nico-site-list-step
Open

Update nicocli site list validation step in documentation#3264
schmaustech wants to merge 1 commit into
NVIDIA:mainfrom
schmaustech:docs/update-nico-site-list-step

Conversation

@schmaustech

Copy link
Copy Markdown
Contributor

This PR updates the nicocli site list command by setting the following env variable correctly to export NICO_API_NAME=nico. The env variable seems to get set without the users knowledge to "carbide" which causes a 404 error. Setting the value to "nico" before running the command resolves this.

Related issues

None

Type of Change

  • Add - New feature or capability
  • Change - Changes in existing functionality
  • Fix - Bug fixes
  • Remove - Removed features or deprecated functionality
  • Internal - Internal changes (refactoring, tests, docs, etc.)

Breaking Changes

  • This PR contains breaking changes

Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • [X ] No testing required (docs, internal refactor, etc.)

Additional Notes

Signed-off-by: Benjamin Schmaus <bschmaus@nvidia.com>
@schmaustech schmaustech requested a review from polarweasel as a code owner July 8, 2026 18:39
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 8680bc66-226b-43cd-8028-5542c9943cc2

📥 Commits

Reviewing files that changed from the base of the PR and between b715487 and beb9418.

📒 Files selected for processing (1)
  • docs/getting-started/quick-start.md

Summary by CodeRabbit

  • Documentation
    • Updated the quick start guide to include a shell variable setup step before verifying your site, helping the next commands run with the correct API name context.

Walkthrough

This change adds a single line to the quick-start documentation, exporting the NICO_API_NAME shell variable prior to running nicocli site list in the "Verify your Site" step.

Changes

Quick-start Documentation Update

Layer / File(s) Summary
Add NICO_API_NAME export to verification step
docs/getting-started/quick-start.md
Inserts export NICO_API_NAME=nico before the nicocli site list command so subsequent commands have the expected API name context.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • NVIDIA/infra-controller#3111: Both PRs modify the "Verify your Site" section of docs/getting-started/quick-start.md, with related updates to the verification command flow.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the documentation update for the nicocli site list validation step.
Description check ✅ Passed The description is directly related to the docs change and explains the NICO_API_NAME fix.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown

🔍 Container Scan Summary

No Grype artifacts were found to aggregate.

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant