Skip to content

Conversation

@kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Aug 20, 2025

Description

This pull request updates documentation references throughout the Redpanda Cloud docs to use direct links to the API reference documentation instead of Antora xref macros and tag variables. This change improves clarity and ensures that API documentation links are always accurate and up to date. Additionally, some outdated branch references are removed from the Antora playbook.

Key documentation improvements:

API Documentation Linking:

  • Replaced Antora xref macros and tag variables with direct link:/api/doc/... references for all Cloud Control Plane and Data Plane API documentation links in navigation and content files. This affects files such as modules/ROOT/nav.adoc, modules/get-started/pages/cloud-overview.adoc, modules/get-started/pages/whats-new-cloud.adoc, modules/develop/pages/connect/about.adoc, modules/manage/partials/controlplane-api.adoc, and modules/networking/pages/azure-private-link.adoc. [1] [2] [3] [4] [5] [6]

Antora Playbook Maintenance:

  • Removed the api branch from the list of tracked branches for the redpanda-data/documentation repository in local-antora-playbook.yml, as it is no longer needed.

Cleanup of Unused Variables:

  • Removed unused :tag-...: variables from modules/manage/partials/controlplane-api.adoc since all related references now use direct links.

Consistency Improvements:

  • Updated all mentions of the Data Plane API in quickstart and overview sections to use the new direct link format for consistency and improved user experience. [1] [2] [3]

These changes help ensure that users are always directed to the latest and most accurate API documentation and reduce the maintenance burden of managing tag variables and xref macros for API links.

Resolves https://github.com/redpanda-data/documentation-private/issues/
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 15:17
@netlify
Copy link

netlify bot commented Aug 20, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 53ca986
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/68a5eee5eb174d0008991ef4
😎 Deploy Preview https://deploy-preview-394--rp-cloud.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

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The Antora playbook (local-antora-playbook.yml) removes the "api" branch from the documentation source branches, keeping [main, v/*, shared, site-search]. The navigation file (modules/ROOT/nav.adoc) updates five Cloud API links to use slug-based references by removing the .adoc extension: Quickstart, Overview, Authentication, Errors and Status Codes, and Deprecation Policy. No other structural or content changes are indicated.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • Add Databricks pages in Cloud #321 — Also updates the Antora playbook branch list and modifies modules/ROOT/nav.adoc, indicating overlapping configuration and navigation changes.

Suggested reviewers

  • Feediver1
  • micheleRP
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bump-topics-patch

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

@kbatuigas kbatuigas merged commit db93ef9 into main Aug 20, 2025
1 check passed
@kbatuigas kbatuigas deleted the bump-topics-patch branch August 20, 2025 16:05
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