Skip to content

Rename BMM to NICo in .md files#261

Closed
Coco-Ben wants to merge 1 commit intoNVIDIA:mainfrom
Coco-Ben:pgambrill/nico-rename
Closed

Rename BMM to NICo in .md files#261
Coco-Ben wants to merge 1 commit intoNVIDIA:mainfrom
Coco-Ben:pgambrill/nico-rename

Conversation

@Coco-Ben
Copy link

Description

Type of Change

  • Feature - New feature or functionality (feat:)
  • Fix - Bug fixes (fix:)
  • Chore - Modification or removal of existing functionality (chore:)
  • Refactor - Refactoring of existing functionality (refactor:)
  • Docs - Changes in documentation or OpenAPI schema (docs:)
  • CI - Changes in Github workflows. Requires additional scrutiny (ci:)
  • Version - Issuing a new release version (version:)

Services Affected

  • API - API models or endpoints updated
  • Workflow - Workflow service updated
  • DB - DB DAOs or migrations updated
  • Site Manager - Site Manager updated
  • Cert Manager - Cert Manager updated
  • Site Agent - Site Agent updated
  • RLA - RLA service updated
  • Powershelf Manager - Powershelf Manager updated
  • NVSwitch Manager - NVSwitch Manager updated

Related Issues (Optional)

Breaking Changes

  • This PR contains breaking changes

Testing

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

Additional Notes

Signed-off-by: Peter Gambrill <pgambrill@nvidia.com>
@coderabbitai
Copy link

coderabbitai bot commented Mar 16, 2026

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated all documentation to reflect the NCX Infra Controller product rebrand, including README files and contribution guidelines.
    • Updated repository references and URLs across all documentation and templates.
    • Updated GitHub issue templates with current community guidelines.

Walkthrough

This pull request rebrand the repository from "NVIDIA Bare Metal Manager" to "NCX Infra Controller" across documentation, issue templates, and README files. All references to the old product name and repository path (bare-metal-manager-rest) are systematically replaced with the new naming (ncx-infra-controller-rest). No functional code changes are introduced.

Changes

Cohort / File(s) Summary
GitHub Issue Templates
.github/ISSUE_TEMPLATE/bug_report.md, .github/ISSUE_TEMPLATE/documentation-request.md, .github/ISSUE_TEMPLATE/feature_request.md, .github/ISSUE_TEMPLATE/submit-question.md
Updated code-of-conduct and contributing guidelines URLs from bare-metal-manager-rest to ncx-infra-controller-rest across all issue templates.
Core Project Documentation
CODE_OF_CONDUCT.md, CONTRIBUTING.md, README.md
Rebranded project references from NVIDIA Bare Metal Manager to NCX Infra Controller; updated repository names, URLs, and product descriptions throughout.
Component Documentation
auth/README.md, cli/README.md, openapi/README.md, sdk/simple/README.md
Updated API references, repository paths, and URLs from bare-metal-manager-rest to ncx-infra-controller-rest in component-specific documentation.
RLA Module Documentation
rla/README.md, rla/docs/component-manager-architecture.md, rla/internal/task/executor/temporalworkflow/README.md
Updated internal package import paths and documentation examples from github.com/nvidia/bare-metal-manager-rest to github.com/nvidia/ncx-infra-controller-rest across RLA documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 The brand takes flight on hoppy feet,
From Bare Metal to Controller suite,
With NCX now leading the way,
Our docs dance with a brighter day!
A rabbit's rebrand, simple and neat! 🌟

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Rename BMM to NICo in .md files' accurately describes the main change: renaming references from BMM (Bare Metal Manager) to NICo (NCX Infra Controller) across documentation files.
Description check ✅ Passed The description properly categorizes the change as documentation-focused (Docs) and indicates no testing is required, which aligns with the changeset of pure documentation updates across multiple .md files.
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
📝 Coding Plan
  • Generate coding plan for human review comments

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

Tip

CodeRabbit can use TruffleHog to scan for secrets in your code with verification capabilities.

Add a TruffleHog config file (e.g. trufflehog-config.yml, trufflehog.yml) to your project to customize detectors and scanning behavior. The tool runs only when a config file is present.

@github-actions
Copy link

🔐 TruffleHog Secret Scan

No secrets or credentials found!

Your code has been scanned for 700+ types of secrets and credentials. All clear! 🎉

🔗 View scan details

🕐 Last updated: 2026-03-16 21:20:16 UTC | Commit: 2067fe9

@github-actions
Copy link

🛡️ Vulnerability Scan

🚨 Found 64 vulnerability(ies)
📊 vs main: 64 (no change)

Severity Breakdown:

  • 🔴 Critical/High: 64
  • 🟡 Medium: 0
  • 🔵 Low/Info: 0

🔗 View full details in Security tab

🕐 Last updated: 2026-03-16 21:20:26 UTC | Commit: 2067fe9

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: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 119-120: The README contains a mismatched directory name: after
cloning "ncx-infra-controller-rest" the next command uses "cd carbide-rest"
which will fail; update the second command to change into the cloned directory
by replacing "cd carbide-rest" with "cd ncx-infra-controller-rest" (or
alternatively change the clone URL to include "carbide-rest" if that's intended)
so the two commands reference the same repository name.

In `@openapi/README.md`:
- Around line 6-8: The README title and first sentence still use "NVIDIA Bare
Metal REST OpenAPI Schema" while the repo URL uses ncx-infra-controller-rest;
update the title string ("NVIDIA Bare Metal REST OpenAPI Schema") and the
description sentence that mentions "OpenAPI schema for NVIDIA Bare Metal REST
endpoints" to the new naming (e.g., "NCX Infra Controller OpenAPI Schema" and
"OpenAPI schema for NCX Infra Controller REST endpoints") so the text matches
the repository URL and naming convention.

In `@README.md`:
- Line 14: Replace the incorrect capitalization "Github pages" with the official
"GitHub pages" in the README line that reads "View latest OpenAPI schema on
Github pages" so the sentence becomes "View latest OpenAPI schema on GitHub
pages"; update any identical occurrences of the string "Github pages" in the
README to "GitHub pages" to ensure consistent, correct branding.

In `@rla/README.md`:
- Line 171: The README import example uses the wrong module path
"github.com/nvidia/ncx-infra-controller-rest"; update it to match the project's
actual module path declared in go.mod and used across sources
("github.com/nvidia/bare-metal-manager-rest") or alternatively change all go.mod
module declarations and every import to the new path; locate the inconsistent
string in the README (the import line referencing psmapi) and either replace
that import to "github.com/nvidia/bare-metal-manager-rest/..." to match existing
imports, or perform a repository-wide refactor updating go.mod files and all
import statements to the new module path so builds and imports are consistent.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b30f1f4a-d08a-44b0-a02e-aedc9ab361ad

📥 Commits

Reviewing files that changed from the base of the PR and between adfc73b and 2067fe9.

📒 Files selected for processing (14)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/documentation-request.md
  • .github/ISSUE_TEMPLATE/feature_request.md
  • .github/ISSUE_TEMPLATE/submit-question.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • README.md
  • auth/README.md
  • cli/README.md
  • openapi/README.md
  • rla/README.md
  • rla/docs/component-manager-architecture.md
  • rla/internal/task/executor/temporalworkflow/README.md
  • sdk/simple/README.md

Comment on lines +119 to 120
git clone https://github.com/<your-username>/ncx-infra-controller-rest.git
cd carbide-rest
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix directory name after clone command.

Line 119 clones ncx-infra-controller-rest, but Line 120 still changes into carbide-rest, which will fail for new contributors.

Suggested doc fix
 git clone https://github.com/<your-username>/ncx-infra-controller-rest.git
-cd carbide-rest
+cd ncx-infra-controller-rest
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
git clone https://github.com/<your-username>/ncx-infra-controller-rest.git
cd carbide-rest
git clone https://github.com/<your-username>/ncx-infra-controller-rest.git
cd ncx-infra-controller-rest
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` around lines 119 - 120, The README contains a mismatched
directory name: after cloning "ncx-infra-controller-rest" the next command uses
"cd carbide-rest" which will fail; update the second command to change into the
cloned directory by replacing "cd carbide-rest" with "cd
ncx-infra-controller-rest" (or alternatively change the clone URL to include
"carbide-rest" if that's intended) so the two commands reference the same
repository name.

Comment on lines 6 to +8
# NVIDIA Bare Metal REST OpenAPI Schema

This repo contains OpenAPI schema for NVIDIA Bare Metal REST endpoints. Redoc rendered latest version can be viewed at https://nvidia.github.io/bare-metal-manager-rest/
This repo contains OpenAPI schema for NVIDIA Bare Metal REST endpoints. Redoc rendered latest version can be viewed at https://nvidia.github.io/ncx-infra-controller-rest/
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Incomplete renaming - title and description still reference old name.

While the URL has been updated to ncx-infra-controller-rest on line 8, the title (line 6) and description text still reference "NVIDIA Bare Metal REST". This creates an inconsistency where the documentation describes itself differently than the repository it references.

Consider updating the title and description to match the new naming scheme, e.g., "NCX Infra Controller OpenAPI Schema".

📝 Suggested update for consistency
-# NVIDIA Bare Metal REST OpenAPI Schema
+# NCX Infra Controller REST OpenAPI Schema

-This repo contains OpenAPI schema for NVIDIA Bare Metal REST endpoints. Redoc rendered latest version can be viewed at https://nvidia.github.io/ncx-infra-controller-rest/
+This repo contains OpenAPI schema for NCX Infra Controller REST endpoints. Redoc rendered latest version can be viewed at https://nvidia.github.io/ncx-infra-controller-rest/
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# NVIDIA Bare Metal REST OpenAPI Schema
This repo contains OpenAPI schema for NVIDIA Bare Metal REST endpoints. Redoc rendered latest version can be viewed at https://nvidia.github.io/bare-metal-manager-rest/
This repo contains OpenAPI schema for NVIDIA Bare Metal REST endpoints. Redoc rendered latest version can be viewed at https://nvidia.github.io/ncx-infra-controller-rest/
# NCX Infra Controller REST OpenAPI Schema
This repo contains OpenAPI schema for NCX Infra Controller REST endpoints. Redoc rendered latest version can be viewed at https://nvidia.github.io/ncx-infra-controller-rest/
🧰 Tools
🪛 LanguageTool

[uncategorized] ~6-~6: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...se-Identifier: Apache-2.0 --> # NVIDIA Bare Metal REST OpenAPI Schema This repo contains...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~8-~8: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...repo contains OpenAPI schema for NVIDIA Bare Metal REST endpoints. Redoc rendered latest v...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

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

In `@openapi/README.md` around lines 6 - 8, The README title and first sentence
still use "NVIDIA Bare Metal REST OpenAPI Schema" while the repo URL uses
ncx-infra-controller-rest; update the title string ("NVIDIA Bare Metal REST
OpenAPI Schema") and the description sentence that mentions "OpenAPI schema for
NVIDIA Bare Metal REST endpoints" to the new naming (e.g., "NCX Infra Controller
OpenAPI Schema" and "OpenAPI schema for NCX Infra Controller REST endpoints") so
the text matches the repository URL and naming convention.

The REST layer can be deployed in the datacenter with NCX Infra Controller Core, or deployed anywhere in Cloud and allow Site Agent to connect from the datacenter. Multiple NCX Infra Controller Cores running in different datacenters can also connect to NCX Infra Controller REST through respective Site Agents.

View latest OpenAPI schema on [Github pages](https://nvidia.github.io/bare-metal-manager-rest/).
View latest OpenAPI schema on [Github pages](https://nvidia.github.io/ncx-infra-controller-rest/).
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Use the official “GitHub” capitalization.

Line 14 should use “GitHub pages” instead of “Github pages”.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~14-~14: The official name of this software platform is spelled with a capital “H”.
Context: ...Agents. View latest OpenAPI schema on [Github pages](https://nvidia.github.io/ncx-inf...

(GITHUB)

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

In `@README.md` at line 14, Replace the incorrect capitalization "Github pages"
with the official "GitHub pages" in the README line that reads "View latest
OpenAPI schema on Github pages" so the sentence becomes "View latest OpenAPI
schema on GitHub pages"; update any identical occurrences of the string "Github
pages" in the README to "GitHub pages" to ensure consistent, correct branding.


```go
import "github.com/nvidia/bare-metal-manager-rest/rla/internal/psmapi"
import "github.com/nvidia/ncx-infra-controller-rest/rla/internal/psmapi"
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check go.mod module declaration
echo "=== Checking go.mod module declaration ==="
fd -e mod -x cat {} | grep -A2 "^module"

# Search for any remaining old import paths in Go files
echo -e "\n=== Searching for old import paths in Go files ==="
rg -t go "github\.com/nvidia/bare-metal-manager-rest" -C2

# Check if new import path is used consistently
echo -e "\n=== Verifying new import paths ==="
rg -t go "github\.com/nvidia/ncx-infra-controller-rest" --stats

Repository: NVIDIA/ncx-infra-controller-rest

Length of output: 50389


Module path in documentation example does not match go.mod or actual imports—fix inconsistency before merge.

The documentation shows github.com/nvidia/ncx-infra-controller-rest in the code example, but verification reveals:

  • go.mod files (root and sub-modules) still declare module github.com/nvidia/bare-metal-manager-rest
  • All Go source files throughout the workflow, db, and common packages still import from github.com/nvidia/bare-metal-manager-rest

Either revert the documentation example to the current module path or update all go.mod files and imports to match the new path. Builds will fail otherwise.

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

In `@rla/README.md` at line 171, The README import example uses the wrong module
path "github.com/nvidia/ncx-infra-controller-rest"; update it to match the
project's actual module path declared in go.mod and used across sources
("github.com/nvidia/bare-metal-manager-rest") or alternatively change all go.mod
module declarations and every import to the new path; locate the inconsistent
string in the README (the import line referencing psmapi) and either replace
that import to "github.com/nvidia/bare-metal-manager-rest/..." to match existing
imports, or perform a repository-wide refactor updating go.mod files and all
import statements to the new module path so builds and imports are consistent.

@thossain-nv
Copy link
Contributor

@Coco-Ben Thanks for starting the rename process, there are some other items that need renaming, I'll use your branch to push the changes.

@thossain-nv
Copy link
Contributor

@Coco-Ben We completed the rename process in #262, closing this.

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.

2 participants