Skip to content

Conversation

@micheleRP
Copy link
Contributor

@micheleRP micheleRP commented Jul 11, 2025

Description

This pull request includes updates to feature statuses, removal of outdated feature flags, and enhancements to the clarity of BYOC/BYOVPC/BYOVNet feature descriptions.

Updates to feature statuses:

Enhancements to BYOC/BYOVPC/BYOVNet descriptions:

Minor adjustments:

Resolves https://redpandadata.atlassian.net/browse/DOC-136
Review deadline:

Page previews

What's New
Cloud Overview beta/LA features
Create BYOVNet Cluster on Azure
Create BYOVPC Cluster on AWS

Checks

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

@micheleRP micheleRP requested a review from a team as a code owner July 11, 2025 20:58
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 11, 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 changes update Redpanda Cloud documentation to reflect the general availability (GA) of Azure BYOVNet (Bring Your Own Virtual Network) clusters. References to "Dedicated and BYOC for Azure" and "Azure Private Link" are removed from limited availability lists, and "BYOVNet for Azure" is removed from beta feature lists. A new section announces the GA of Azure BYOVNet clusters. The Azure Private Link documentation is significantly expanded with clarifying notes, detailed procedural instructions, and explicit command examples. The metadata indicating beta status is removed from the Azure BYOVNet documentation page.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    participant Redpanda Cloud API
    participant Azure CLI

    User->>Documentation: Reads updated Azure BYOVNet/Private Link docs
    User->>Redpanda Cloud API: Creates network/cluster (using documented curl commands)
    Redpanda Cloud API-->>User: Returns operation status and details
    User->>Azure CLI: Executes resource group, VNet, and Private Link endpoint creation
    Azure CLI-->>User: Confirms resource and DNS setup
    User->>Documentation: Follows step-by-step instructions for configuration
Loading

Assessment against linked issues

Objective Addressed Explanation
Document feature: Azure Implementation for Cloud (GA) (DOC-136)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Possibly related PRs

Suggested reviewers

  • kbatuigas
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DOC-136-Document-feature-Azure-Implementation-for-Cloud-GA

🪧 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.
    • Explain this complex logic.
    • 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. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • 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 src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

Documentation and Community

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

@netlify
Copy link

netlify bot commented Jul 11, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit db98ffa
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/688a82d36c2e8900088a972e
😎 Deploy Preview https://deploy-preview-353--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.

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 204c349 and 7247281.

📒 Files selected for processing (4)
  • modules/get-started/pages/cloud-overview.adoc (0 hunks)
  • modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc (1 hunks)
  • modules/get-started/pages/whats-new-cloud.adoc (1 hunks)
  • modules/networking/pages/azure-private-link.adoc (0 hunks)
💤 Files with no reviewable changes (2)
  • modules/get-started/pages/cloud-overview.adoc
  • modules/networking/pages/azure-private-link.adoc
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.
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.
Learnt from: david-yu
PR: redpanda-data/cloud-docs#338
File: modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc:74-75
Timestamp: 2025-06-24T03:31:29.345Z
Learning: User david-yu indicated that the standard Azure zones format using plain numbers like "1", "2", "3" is not valid for their specific Azure BYOVNet setup, suggesting there may be specific tooling or API requirements that expect region-prefixed zone names like "centralus-az1".
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#334
File: modules/networking/partials/psc-api2.adoc:15-16
Timestamp: 2025-06-18T21:02:38.074Z
Learning: In the Redpanda Cloud documentation system, cross-reference anchors using the format `#patch-/v1/clusters/-cluster.id-` work correctly for referencing API endpoints, even with dashes instead of curly braces around parameter names.
modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc (1)
Learnt from: david-yu
PR: redpanda-data/cloud-docs#338
File: modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc:74-75
Timestamp: 2025-06-24T03:31:29.345Z
Learning: User david-yu indicated that the standard Azure zones format using plain numbers like "1", "2", "3" is not valid for their specific Azure BYOVNet setup, suggesting there may be specific tooling or API requirements that expect region-prefixed zone names like "centralus-az1".
modules/get-started/pages/whats-new-cloud.adoc (3)
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.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#334
File: modules/networking/partials/psc-api2.adoc:15-16
Timestamp: 2025-06-18T21:02:38.074Z
Learning: In the Redpanda Cloud documentation system, cross-reference anchors using the format `#patch-/v1/clusters/-cluster.id-` work correctly for referencing API endpoints, even with dashes instead of curly braces around parameter names.
🔇 Additional comments (1)
modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc (1)

3-3: Beta flag removed – verify that no residual “beta/LA” language remains

The :page-beta: attribute was successfully removed, but double-check the body for any lingering wording that still calls the feature beta or limited availability so readers don’t get mixed messages.

@redpanda-data redpanda-data deleted a comment from coderabbitai bot Jul 11, 2025
@micheleRP micheleRP requested review from david-yu and deniscoady July 14, 2025 21:41
@micheleRP micheleRP merged commit 1ab60ba into main Jul 30, 2025
5 checks passed
@micheleRP micheleRP deleted the DOC-136-Document-feature-Azure-Implementation-for-Cloud-GA branch July 30, 2025 20:42
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.

4 participants