Skip to content

Conversation

micheleRP
Copy link
Contributor

@micheleRP micheleRP commented Sep 12, 2025

Description

This pull request updates the Redpanda Cloud documentation to make it clear that Premium support is required for BYOVPC.

  • Updated the support matrix to specify that BYOVPC deployments require Premium support.
  • Revised the support description to clarify that Enterprise support provides access to streaming experts 24/5 with 24/7 priority escalation, and that Premium support provides an enhanced Support SLA.
  • Changed the BYOVPC/BYOVNet feature flag note to state that Premium support is required for an enhanced Support SLA, replacing the previous language about additional purchase.

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

Page previews

Cloud Overview (see last row of table + note below table)
Create BYOVPC/VNet for AWS/Azure/GCP (see Important admonition at top of page: note that AWS and Azure are still in beta, and we say Redpanda Support does not support beta features)

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 September 12, 2025 23:02
Copy link

netlify bot commented Sep 12, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 238ba16
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/68caf4f4002f3a000812a81f
😎 Deploy Preview https://deploy-preview-410--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 bot commented Sep 12, 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

Text-only documentation updates in two files:

  • In modules/get-started/pages/cloud-overview.adoc: Adjusted Redpanda Support wording in the Quick comparison table to distinguish BYOC vs BYOVPC (Enterprise support for BYOC; Premium support required for BYOVPC/BYOVNet); updated NOTE to specify 24/5 access with 24/7 priority escalation and that Premium support provides enhanced response SLAs.
  • In modules/shared/partials/feature-flag-rpcn.adoc: Clarified that BYOVPC/BYOVNet require Premium Support for enhanced response SLAs; the unlock flow and Redpanda Sales link remain unchanged.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • paulohtb6
  • david-yu
  • Feediver1

Pre-merge checks

✅ Passed checks (5 passed)
Check name Status Explanation
Title Check ✅ Passed The title "DOC-1658 BYOVPC requires premium support" is concise, directly reflects the primary change in the PR, and highlights the most important update from the developer's perspective (making BYOVPC require Premium Support). It is specific and readable, and a teammate scanning history will understand the main intent without extra noise. The title matches the modified files and the linked issue objective.
Linked Issues Check ✅ Passed The changes implement the linked issue DOC-1658 by updating the Cloud Overview support matrix to require Premium Support for BYOVPC, revising the Enterprise support wording to 24/5 with 24/7 priority escalation, and changing the BYOVPC/BYOVNet feature-flag note to require Premium Support; these edits appear in modules/get-started/pages/cloud-overview.adoc and modules/shared/partials/feature-flag-rpcn.adoc. The modifications directly satisfy the coding-related objective to indicate Premium Support is required for BYOVPC/BYOVNet. I find the PR compliant with the linked issue's requirements.
Out of Scope Changes Check ✅ Passed All file changes in the PR are confined to Cloud Overview and the shared feature-flag partial and are limited to support messaging and related copy updates about BYOVPC/BYOVNet and support levels. There are no edits to unrelated modules, functionality, or configuration files that would indicate out-of-scope changes. The PR appears focused and in-scope for the linked issue.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed The PR description largely follows the repository template: it contains a clear Description section with a concise summary of changes, a "Resolves" reference to the linked issue, page preview links, and the Checks section. However, the "Resolves" entry points to a Jira ticket rather than the template's expected GitHub issue URL and the "Review deadline:" field is left blank. These are minor deviations and the body is otherwise sufficiently detailed to convey the PR's intent and scope.

Comment @coderabbitai help to get the list of available commands and usage tips.

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
modules/get-started/pages/cloud-overview.adoc (1)

372-393: Remove/reconcile legacy "add‑on / additional purchase" messaging for BYOVPC/BYOVNet

cloud-overview now lists BYOVPC (AWS) and BYOVNet (Azure) as beta — several pages still call them "add‑on", "may require an additional purchase", or instruct readers to "unlock this feature". Update wording to reflect current beta/support status or explicitly state current purchase/support requirements.

Files to update:

  • modules/shared/partials/feature-flag-rpcn.adoc — line 3: "BYOVPC/BYOVNet is an add-on feature that requires Premium Support..."
  • modules/get-started/pages/cluster-types/byoc/gcp/enable-secrets-byovpc-gcp.adoc — line 7: "BYOVPC is an add-on feature that may require an additional purchase."
  • modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc — line 6: same wording.
  • modules/get-started/pages/cloud-overview.adoc — reconcile beta feature list (lines ~385–389) with support/purchase references (e.g., enterprise/Premium support table around lines ~99 and 'To unlock...' messaging near line ~296).

Action: remove or reword "add‑on"/"additional purchase"/"unlock this feature" language (or clearly state the current policy) so all pages are consistent with cloud-overview.

🧹 Nitpick comments (3)
modules/shared/partials/feature-flag-rpcn.adoc (1)

3-3: Standardize support-tier capitalization to "Enterprise Support" and "Premium Support"

Replace occurrences of "Enterprise support" / "Premium support" with Title Case across the docs; keep "BYOVPC/BYOVNet" unchanged.

Files to update:

  • modules/get-started/pages/cloud-overview.adoc — lines ~96–99, 106–107
  • modules/get-started/partials/get-started-serverless.adoc — lines ~17, 26
  • modules/get-started/pages/whats-new-cloud.adoc — lines ~237–238
modules/get-started/pages/cloud-overview.adoc (2)

106-106: Proper-case support tier names for consistency

Capitalize product tier names.

-* Enterprise support provides access to streaming experts 24/5, with 24/7 priority escalation for production outages. Premium support offers enhanced response SLAs.
+* Enterprise Support provides access to streaming experts 24/5, with 24/7 priority escalation for production outages. Premium Support offers enhanced response SLAs.

151-157: Optional: add a cross-reference or note about Premium Support in BYOVPC/BYOVNet section

Consider an inline NOTE here to reiterate the Premium Support requirement to reduce context-switching for readers who skim sections.

I can propose a one-line NOTE with consistent phrasing if helpful.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between b02aef5 and 08aebae.

📒 Files selected for processing (2)
  • modules/get-started/pages/cloud-overview.adoc (1 hunks)
  • modules/shared/partials/feature-flag-rpcn.adoc (1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.061Z
Learning: In Redpanda Cloud documentation, BYOVPC and BYOVNet are different product names for different cloud providers: BYOVPC is used for AWS and GCP, while BYOVNet is used for Azure. When documentation sections cover multiple cloud providers, the combined notation "BYOVPC/BYOVNet" is correct and should not be changed to use only one term.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#377
File: modules/networking/pages/dedicated/gcp/configure-psc-in-ui.adoc:35-71
Timestamp: 2025-08-07T16:36:45.111Z
Learning: In Redpanda Cloud documentation, NAT subnet and firewall rule creation commands for GCP Private Service Connect are producer-side infrastructure steps that only BYOC (Bring Your Own Cloud) customers need to perform, since they manage their own VPC. Dedicated cluster customers don't need these steps because Redpanda manages the infrastructure for them. The ifdef::env-byoc[] guard correctly hides these commands from Dedicated users.
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.
📚 Learning: 2025-07-21T21:52:17.061Z
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.061Z
Learning: In Redpanda Cloud documentation, BYOVPC and BYOVNet are different product names for different cloud providers: BYOVPC is used for AWS and GCP, while BYOVNet is used for Azure. When documentation sections cover multiple cloud providers, the combined notation "BYOVPC/BYOVNet" is correct and should not be changed to use only one term.

Applied to files:

  • modules/shared/partials/feature-flag-rpcn.adoc
📚 Learning: 2025-08-07T16:36:45.111Z
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#377
File: modules/networking/pages/dedicated/gcp/configure-psc-in-ui.adoc:35-71
Timestamp: 2025-08-07T16:36:45.111Z
Learning: In Redpanda Cloud documentation, NAT subnet and firewall rule creation commands for GCP Private Service Connect are producer-side infrastructure steps that only BYOC (Bring Your Own Cloud) customers need to perform, since they manage their own VPC. Dedicated cluster customers don't need these steps because Redpanda manages the infrastructure for them. The ifdef::env-byoc[] guard correctly hides these commands from Dedicated users.

Applied to files:

  • modules/shared/partials/feature-flag-rpcn.adoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - rp-cloud
  • GitHub Check: Header rules - rp-cloud
  • GitHub Check: Pages changed - rp-cloud

@micheleRP
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Sep 15, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@micheleRP micheleRP merged commit cbd9352 into main Sep 17, 2025
5 checks passed
@micheleRP micheleRP deleted the DOC-1658-BYOVPC-requires-premium-support branch September 17, 2025 18:59
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.

2 participants