Skip to content

fix: RA2.1 README points to wrong sibling profile name - #208

Open
andrewwhitecdw wants to merge 1 commit into
NVIDIA:mainfrom
andrewwhitecdw:bugfix/readme-ra2-1-readme-points-to-wrong-sibling
Open

fix: RA2.1 README points to wrong sibling profile name#208
andrewwhitecdw wants to merge 1 commit into
NVIDIA:mainfrom
andrewwhitecdw:bugfix/readme-ra2-1-readme-points-to-wrong-sibling

Conversation

@andrewwhitecdw

Copy link
Copy Markdown

This PR corrects the documentation in profiles/spectrum-x-ra2.1/README.md: RA2.1 README points to wrong sibling profile name.

Changes

  • profiles/spectrum-x-ra2.1/README.md: RA2.1 README points to wrong sibling profile name.

Details

--- a/profiles/spectrum-x-ra2.1/README.md
+++ b/profiles/spectrum-x-ra2.1/README.md
@@ -1,3 +1,3 @@
-sibling of the `spectrum-x` profile, which targets **RA2.2** on **26.4+**.
-...
-use the `spectrum-x` profile instead
+sibling of the `spectrum-x-ra2.2` profile, which targets **RA2.2** on **26.4+**.
+...
+use the `spectrum-x-ra2.2` profile instead

Tests

  • profiles/readme_test.go
diff --git a/profiles/readme_test.go b/profiles/readme_test.go
new file mode 100644
--- /dev/null
+++ b/profiles/readme_test.go
@@ -0,0 +1,33 @@
+package profiles
+
+import (
+	"os"
+	"path/filepath"
+	"strings"
+	"testing"
+)
+
+func TestSpectrumXRA2_1ReadmeSiblingProfile(t *testing.T) {
+	readmePath := filepath.Join("spectrum-x-ra2.1", "README.md")
+	b, err := os.ReadFile(readmePath)
+	if err != nil {
+		t.Fatalf("reading %s: %v", readmePath, err)
+	}
+	content := string(b)
+
+	// The RA2.1 README must point users at the pinned RA2.2 sibling, not at
+	// the current `spectrum-x` profile which now tracks RA2.3/26.7.
+	if strings.Contains(content, "sibling of the `spectrum-x` profile") {
+		t.Errorf("README contains stale sibling reference to `spectrum-x`; use `spectrum-x-ra2.2` instead")
+	}
+	if strings.Contains(content, "use the `spectrum-x` profile instead") {
+		t.Errorf("README contains stale fallback reference to `spectrum-x`; use `spectrum-x-ra2.2` instead")
+	}
+	if !strings.Contains(content, "sibling of the `spectrum-x-ra2.2` profile") {
+		t.Errorf("README should reference the `spectrum-x-ra2.2` sibling profile")
+	}
+	if !strings.Contains(content, "use the `spectrum-x-ra2.2` profile instead") {
+		t.Errorf("README should direct 26.4+ users to the `spectrum-x-ra2.2` profile")
+	}
+}

Contributor guidelines

Per this repo's CONTRIBUTING.md:

  • All commits are signed off (Signed-off-by trailer, DCO).

Signed-off-by: andrewwhitecdw <andrewwhitecdw@users.noreply.github.com>
@greptile-apps

greptile-apps Bot commented Aug 17, 2026

Copy link
Copy Markdown

Greptile Summary

Corrects the RA2.1 profile documentation so users running Network Operator 26.4+ are directed to the pinned RA2.2 sibling rather than the current RA2.3 profile.

  • Replaces both stale spectrum-x references with spectrum-x-ra2.2.

Confidence Score: 5/5

The documentation-only correction appears safe to merge.

The updated sibling and fallback references accurately direct 26.4+ users to the dedicated RA2.2 profile, with no runtime or security behavior affected.

Important Files Changed

Filename Overview
profiles/spectrum-x-ra2.1/README.md The two corrected references now agree with the documented profile matrix: RA2.1 targets 26.1, RA2.2 targets 26.4+, and the unpinned Spectrum-X profile targets RA2.3.

Reviews (1): Last reviewed commit: "fix: RA2.1 README points to wrong siblin..." | Re-trigger Greptile

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