Skip to content

Conversation

@kbatuigas
Copy link
Contributor

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 main branch -- 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

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@kbatuigas kbatuigas requested a review from a team as a code owner August 20, 2025 17:36
@netlify
Copy link

netlify bot commented Aug 20, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 0a0a90a
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/68a607868883bd0009c65ae6
😎 Deploy Preview https://deploy-preview-1330--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
Copy link
Contributor

coderabbitai bot commented Aug 20, 2025

📝 Walkthrough

Walkthrough

This 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

  • mattschumpert
  • micheleRP
  • Feediver1

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
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bump-topics-cleanup

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

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

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
modules/manage/partials/mountable-topics.adoc (1)

14-14: Confirm Bump doc URL and standardize “/api” vs “/api/doc” usage

You 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.

📥 Commits

Reviewing files that changed from the base of the PR and between d0a074c and 0a0a90a.

📒 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 segment

The 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 accounts

Pointing 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 clearer

Linking 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.

Copy link
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

lgtm

@kbatuigas kbatuigas merged commit 2c09040 into main Aug 20, 2025
7 checks passed
@kbatuigas kbatuigas deleted the bump-topics-cleanup branch August 20, 2025 18:14
@coderabbitai coderabbitai bot mentioned this pull request Sep 19, 2025
4 tasks
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.

3 participants