Add deprecation notice for Cloud API #306
Conversation
|
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 documentation was updated to announce the deprecation of specific Cloud API versions: Control Plane API versions v1beta1 and v1beta2, and Data Plane API versions v1alpha1 and v1alpha2. Notices were added in the "What's New" section, the Cloud API overview, and the maintenance/deprecation table. Each update clearly states that these API versions are deprecated, will be removed in a future release, and are not recommended for use. References to the Cloud API deprecation policy are included for further details. Assessment against linked issues
Suggested reviewers
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
modules/manage/pages/maintenance.adoc (1)
120-120: Remove trailing whitespace in Deprecated features table
The February 2025 entry line ends with extra spaces, which may affect table rendering. Please trim the trailing whitespace.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
modules/get-started/pages/whats-new-cloud.adoc(1 hunks)modules/manage/pages/api/cloud-api-overview.adoc(2 hunks)modules/manage/pages/maintenance.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
🔇 Additional comments (4)
modules/manage/pages/api/cloud-api-overview.adoc (2)
52-53: Approve Control Plane API deprecation notice
The added admonition clearly flags the deprecation of v1beta1/v1beta2, maintains consistent formatting with other notices, and correctly links to the deprecation policy.
65-66: Approve Data Plane API deprecation notice
The new notice mirrors the Control Plane deprecation language for v1alpha1/v1alpha2, ensuring consistency across API docs and referencing the policy for details.modules/get-started/pages/whats-new-cloud.adoc (1)
12-15: Approve "Cloud API beta versions deprecated" section
The new section under May 2025 succinctly communicates the deprecation of the specified API versions, follows the established “What’s New” format, and includes a link to the deprecation policy. It aligns with the overview and maintenance updates.modules/manage/pages/maintenance.adoc (1)
118-118: Approve new deprecation table entry for Cloud API beta versions
The May 2025 entry accurately documents the deprecation of both Control and Data Plane API beta versions, omits explicit timeline duration per policy, and references the deprecation policy.
towfiqa
left a comment
towfiqa
left a comment
There was a problem hiding this comment.
Looks perfect! Thank you for putting this together
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
Files not reviewed (3)
- modules/get-started/pages/whats-new-cloud.adoc: Language not supported
- modules/manage/pages/api/cloud-api-overview.adoc: Language not supported
- modules/manage/pages/maintenance.adoc: Language not supported
Co-authored-by: Michele Cyran <michele@redpanda.com>
Description
This pull request focuses on documenting the deprecation of several Cloud API beta versions and updating relevant sections across multiple documentation files. The most important changes involve adding notices about the deprecated API versions and linking to the deprecation policy for further details.
Deprecation Notices for Cloud API Versions:
modules/get-started/pages/whats-new-cloud.adoc: Added a new section under "May 2025" announcing the deprecation of Cloud Control Plane API versionsv1beta1andv1beta2, and Data Plane API versionsv1alpha1andv1alpha2. These versions are marked for future removal and are not recommended for use.modules/manage/pages/api/cloud-api-overview.adoc: Added deprecation notices for Control Plane API versionsv1beta1andv1beta2and Data Plane API versionsv1alpha1andv1alpha2, specifying that these versions are still available but will be removed in a future release. [1] [2]modules/manage/pages/maintenance.adoc: Updated the deprecation table to include the May 2025 deprecation of the aforementioned Cloud API versions, with a link to the deprecation policy for additional details.Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:
Page previews
Cloud API Overview
What's New
Upgrades and Maintenance > Deprecated features
Checks