-
Notifications
You must be signed in to change notification settings - Fork 4
DOC-1497 update Customer-managed to BYOVPC #352
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
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 for creating a BYOVPC (Bring Your Own VPC) cluster on GCP in Redpanda Cloud was updated. The change specifically alters the label for the network connection type on the Network page from "Customer-managed" to "BYOVPC." The instructions now direct users to select the "BYOVPC" option instead of "Customer-managed" when configuring network details during cluster creation. No other procedural or functional documentation changes were made. Assessment against linked issues
Possibly related PRs
🪧 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc (1)
672-676: Ensure terminology consistency (“customer-managed” → “BYOVPC”).Now that the UI label has changed to BYOVPC, the follow-on bullet still refers to “customer-managed networks”, which can confuse readers.
- . With customer-managed networks, you must grant yourself (the user deploying the cluster with `rpk`) the following permissions: + . With BYOVPC networks, you must grant yourself (the user deploying the cluster with `rpk`) the following permissions:Updating the wording keeps the doc aligned with the UI and the new terminology.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: asimms41
PR: redpanda-data/cloud-docs#291
File: modules/develop/pages/connect/components/processors/google_drive_download.adoc:1-1
Timestamp: 2025-05-13T13:20:39.044Z
Learning: In Redpanda Cloud documentation, component titles (particularly processors) follow a standard naming convention that uses underscores (like "google_drive_download") rather than human-readable titles. This convention should be maintained for consistency across all component documentation.
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.
⏰ 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
Description
This pull request updates the documentation for creating a BYOC cluster in GCP. The most notable change is the clarification of the connection type for the Network page.
modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc: Updated the connection type from Customer-managed to BYOVPC in the instructions for creating a BYOC cluster in GCP.Resolves https://redpandadata.atlassian.net/browse/DOC-1497
Review deadline:
Page previews
https://deploy-preview-352--rp-cloud.netlify.app/redpanda-cloud/get-started/cluster-types/byoc/gcp/vpc-byo-gcp/#create-cluster
Checks