-
Notifications
You must be signed in to change notification settings - Fork 47
[25.2] Bump topics cleanup #1330
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis PR updates documentation across three AsciiDoc files. It replaces internal xref links with absolute link:/api/... URLs for Cloud Control Plane/Data Plane authentication and API overview. It revises anchors and labels in the Iceberg/Snowflake catalog page to point to updated sections, adds prerequisite notes for non-cloud setups, and expands code snippets with explicit placeholder guidance for Snowflake Open Catalog integration. It also updates cloud cluster configuration references from secret storage to editing cluster configuration and adds minor tips and verification examples. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
modules/manage/partials/mountable-topics.adoc (1)
14-14: Confirm Bump doc URL and standardize “/api” vs “/api/doc” usageYou switched to link:/api/doc/cloud-dataplane/authentication, while other places in this PR use both “/api/…” and “/api/doc/…”. Please verify this URL resolves in the preview and consider standardizing the pattern across files (and between Control Plane vs Data Plane links) to avoid link rot and inconsistency.
Would you like me to scan the repo for “/api/doc/” vs “/api/” occurrences and prepare a follow-up PR to normalize them?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc(2 hunks)modules/manage/partials/iceberg/use-iceberg-catalogs.adoc(1 hunks)modules/manage/partials/mountable-topics.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (3)
modules/manage/partials/iceberg/use-iceberg-catalogs.adoc (1)
119-119: Cloud API Overview link looks good; please verify path segmentThe external link to the Cloud API Overview under the Data Plane docs is a good move. Please double-check that link:/api/doc/cloud-dataplane/topic/topic-cloud-api-overview resolves as expected in the preview (the “topic/…” segment can vary by Bump config).
modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc (2)
17-18: Good switch to Control Plane authentication for service accountsPointing users to link:/api/cloud-controlplane/authentication for service account auth in Cloud is correct and clearer than the previous internal xref. LGTM.
69-70: Updated anchor and guidance are accurate and clearerLinking to use-a-secret-in-cluster-configuration aligns with the revised partial and clarifies that Control Plane API or rpk can be used to apply the secret reference. Looks good.
micheleRP
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Description
This is the remainder of old xrefs that should now point to the new Bump API docs instead. This fixes build errors seen on the
mainbranch -- more PRs will be open to clean up the rest of the xrefs in 25.1, 24.3, 24.2, and 24.1.Resolves https://redpandadata.atlassian.net/browse/
Review deadline:
Page previews
Checks