-
Notifications
You must be signed in to change notification settings - Fork 4
Bump topics patch #394
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
Bump topics patch #394
Conversation
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe 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
Suggested reviewers
✨ 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 (
|
5b3cecb to
53ca986
Compare
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:
link:/api/doc/...references for all Cloud Control Plane and Data Plane API documentation links in navigation and content files. This affects files such asmodules/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, andmodules/networking/pages/azure-private-link.adoc. [1] [2] [3] [4] [5] [6]Antora Playbook Maintenance:
apibranch from the list of tracked branches for theredpanda-data/documentationrepository inlocal-antora-playbook.yml, as it is no longer needed.Cleanup of Unused Variables:
:tag-...:variables frommodules/manage/partials/controlplane-api.adocsince all related references now use direct links.Consistency Improvements:
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