Skip to content

Conversation

@micheleRP
Copy link
Contributor

@micheleRP micheleRP commented Jun 18, 2025

Description

This pull request updates documentation to standardize terminology by replacing "BYOVPC" with "BYOVNet" where applicable, reflecting the support for both Virtual Private Clouds (VPCs) and Virtual Networks (VNets).

Terminology Standardization:

  • Updated "BYOVPC" to "BYOVPC/BYOVNet" in modules/get-started/pages/cloud-overview.adoc to reflect support for both VPCs and VNets across AWS, GCP, and Azure. [1] [2]
  • Changed "BYOVPC" to "BYOVNet" in Azure-specific documentation to align with Azure's terminology for Virtual Networks (VNets). [1] [2] [3]

Feature Availability Updates:

  • Updated feature availability lists to replace "BYOVPC" with "BYOVNet" for Azure and clarify the scope of Redpanda Connect support. [1] [2]

These changes ensure consistency across the documentation and improve clarity for users managing Redpanda clusters in different cloud environments.

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

Page previews

Cloud Overview
Create a BYOVNet Cluster on Azure

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 June 18, 2025 22:14
@netlify
Copy link

netlify bot commented Jun 18, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 08a78bb
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6859e8a6239c0c0008f26dc7
😎 Deploy Preview https://deploy-preview-335--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 Jun 18, 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 documentation was updated to standardize and clarify terminology related to network deployment options for Redpanda Cloud BYOC clusters. All references to "BYOVPC" in the context of Azure were changed to "BYOVNet" to accurately reflect Azure's use of Virtual Networks (VNet) instead of Virtual Private Clouds (VPC). Section titles, feature lists, shared responsibility tables, and descriptive text were revised to consistently use "BYOVPC/BYOVNet" when referring to customer-managed networks across AWS, GCP, and Azure. No procedural, code, or technical instructions were altered.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Rename BYOVPC on Azure to BYOVNET (DOC-1458)

Suggested reviewers

  • tomasz-sadura
  • kbatuigas

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.

❤️ Share
🪧 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 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.

@micheleRP micheleRP requested a review from david-yu June 18, 2025 22:19
Copy link
Contributor

@david-yu david-yu left a comment

Choose a reason for hiding this comment

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

Looks good to me thank you!

Copy link
Contributor

@kbatuigas kbatuigas left a comment

Choose a reason for hiding this comment

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

Just one suggestion to look into but no blockers otherwise!

:description: Connect Redpanda Cloud to your existing VNet for additional security.
:page-beta: true

include::shared:partial$feature-flag-rpcn.adoc[]
Copy link
Contributor

Choose a reason for hiding this comment

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

This partial at the top still only says BYOVPC: https://deploy-preview-335--rp-cloud.netlify.app/redpanda-cloud/get-started/cluster-types/byoc/azure/vnet-azure/ do we need to change it there too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks Kat! I updated the partial.

@micheleRP micheleRP merged commit fd5d744 into main Jun 23, 2025
5 checks passed
@micheleRP micheleRP deleted the DOC-1458-rename-BYOVPC-on-Azure-to-BYOVNET branch June 23, 2025 23:55
@coderabbitai coderabbitai bot mentioned this pull request Aug 15, 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.

4 participants