Skip to content

docs: remove NodePool CRD documentation (26.1, internal/BYOC only)#1800

Open
JakeSCahill wants to merge 1 commit into
mainfrom
doc-remove-nodepool-docs-26-1
Open

docs: remove NodePool CRD documentation (26.1, internal/BYOC only)#1800
JakeSCahill wants to merge 1 commit into
mainfrom
doc-remove-nodepool-docs-26-1

Conversation

@JakeSCahill

Copy link
Copy Markdown
Contributor

26.1 counterpart of #1799, per @david-yu on #1681: the NodePool CRD is internal to Redpanda Cloud (BYOC) and shouldn't be documented for self-managed users.

Changes

  • Deletes manage:kubernetes/k-node-pools.adoc and upgrade:k-migrate-node-pools.adoc + nav entries; cleans inbound xrefs (k-scale-redpanda, k-decommission-brokers, k-migrate-node-pools-manually). The manual node-pool migration guide stays.

Comms for existing adopters (this line is the published 26.1 docs, so removal is user-visible)

  • Old URLs redirect, not 404: both removed pages alias to Scale Redpanda, so bookmarks and inbound links keep working.
  • Release notes carry a removal notice in place of the old "NodePool CRD (beta)" section: the CRD keeps working and stays maintained; docs removed because it's internal to BYOC; self-managed adopters should contact their account team. (docs: remove NodePool CRD documentation (internal/BYOC only) #1799 adds the equivalent note to the 26.2 release notes.)
  • Recommended follow-up outside the docs: since adoption required two explicit opt-ins (crds.experimental + --enable-v2-nodepools), any self-managed adopters are likely few and identifiable — suggest PM/support directly notify known users rather than a broad announcement.

🤖 Generated with Claude Code

Per engineering, the NodePool CRD is used internally for Redpanda Cloud
(BYOC) deployments and should not be documented for self-managed users,
even though it remains actively maintained.

Removes the Node Pools page and the NodePool blue/green migration
guide, their nav entries, and inbound cross-references. The release
notes entry is replaced with a removal notice directing existing
adopters to their account team, and the old URLs redirect to Scale
Redpanda via page-aliases. The manual node-pool migration guide stays.
@JakeSCahill JakeSCahill requested a review from a team as a code owner July 15, 2026 12:25
@netlify

netlify Bot commented Jul 15, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 471dab3
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a577c2b1e08050008dc0483
😎 Deploy Preview https://deploy-preview-1800--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jul 15, 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: dee86376-2d5a-4590-b671-cdaf10b91a6a

📥 Commits

Reviewing files that changed from the base of the PR and between 5c4a9f9 and 471dab3.

📒 Files selected for processing (7)
  • modules/ROOT/nav.adoc
  • modules/get-started/pages/release-notes/operator.adoc
  • modules/manage/pages/kubernetes/k-decommission-brokers.adoc
  • modules/manage/pages/kubernetes/k-node-pools.adoc
  • modules/manage/pages/kubernetes/k-scale-redpanda.adoc
  • modules/upgrade/pages/k-migrate-node-pools-manually.adoc
  • modules/upgrade/pages/k-migrate-node-pools.adoc
💤 Files with no reviewable changes (5)
  • modules/upgrade/pages/k-migrate-node-pools-manually.adoc
  • modules/manage/pages/kubernetes/k-node-pools.adoc
  • modules/upgrade/pages/k-migrate-node-pools.adoc
  • modules/manage/pages/kubernetes/k-decommission-brokers.adoc
  • modules/ROOT/nav.adoc

📝 Walkthrough

Walkthrough

The changes retire self-managed NodePool documentation and automated migration guidance. The operator release notes now state that NodePool documentation is removed for self-managed deployments while the CRD remains maintained. Navigation entries, cross-references, suggested reading, and migration guidance are removed or updated, and scale-page aliases are expanded to cover related legacy routes.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: david-yu

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change, but it omits the required Jira link, review deadline, page previews, and checklist. Add the required template sections: Jira ticket, review deadline, page previews, and the Checks checklist.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the main docs removal.
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
  • Commit unit tests in branch doc-remove-nodepool-docs-26-1

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.

❤️ Share

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

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