DOC-1519 BYOVNet replace for Azure #364
Conversation
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis change updates documentation across multiple files to clarify and standardize cluster type terminology in the context of Azure. Specifically, references to "BYOVPC" clusters are replaced or supplemented with "BYOVNet" clusters, explicitly excluding both BYOVPC and BYOVNet clusters where appropriate. The updates affect prerequisite descriptions, feature availability notes, release notes, and Terraform provider documentation. No procedural, functional, or logic changes are introduced; all modifications are limited to documentation language for accuracy and consistency. Estimated code review effort1 (~5 minutes) Possibly related PRs
Suggested reviewers
🪧 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 (
|
![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/develop/pages/agents/create-support-agent.adoc (1)
17-17: Minor readability nit.The parenthetical now reads “(not BYOVPC/BYOVNet)”. Consider adding a brief clarifier so readers immediately understand why these BYOC variants are excluded, for example:
- A running Dedicated or BYOC (not BYOVPC/BYOVNet) cluster. + A running Dedicated or standard BYOC cluster (customer-managed network variants BYOVPC/BYOVNet are not supported).Purely optional, but it may spare users a quick trip to the glossary.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
modules/develop/pages/agents/create-support-agent.adoc(1 hunks)modules/develop/pages/connect/configuration/resource-management.adoc(1 hunks)modules/develop/pages/connect/configuration/secret-management.adoc(1 hunks)modules/get-started/pages/whats-new-cloud.adoc(1 hunks)modules/manage/pages/terraform-provider.adoc(1 hunks)modules/security/partials/iam-policies.adoc(1 hunks)modules/shared/partials/feature-flag-agents.adoc(1 hunks)
🧠 Learnings (8)
📓 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.037Z
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: 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#361
File: modules/networking/pages/cloud-security-network.adoc:193-196
Timestamp: 2025-07-21T21:53:37.669Z
Learning: In Redpanda Cloud documentation, field names and labels should match exactly what appears in the UI, even if the terminology might seem technically inconsistent. For example, the NAT gateway IP address field is labeled "Internet gateway" in the UI, so documentation should use "Internet gateway" to help users locate the correct field.
Learnt from: ncole
PR: redpanda-data/cloud-docs#356
File: modules/get-started/pages/cluster-types/byoc/azure/create-byoc-cluster-azure.adoc:101-118
Timestamp: 2025-07-16T18:50:06.882Z
Learning: In Azure documentation, when checking SKU restrictions with `az vm list-skus`, use the specific SKU size (e.g., Standard_D2d_v5) rather than the family name. However, for quota checking, family names are used. These serve different purposes in Azure resource management.
modules/manage/pages/terraform-provider.adoc (5)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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: #361
File: modules/networking/pages/cloud-security-network.adoc:193-196
Timestamp: 2025-07-21T21:53:37.669Z
Learning: In Redpanda Cloud documentation, field names and labels should match exactly what appears in the UI, even if the terminology might seem technically inconsistent. For example, the NAT gateway IP address field is labeled "Internet gateway" in the UI, so documentation should use "Internet gateway" to help users locate the correct field.
Learnt from: micheleRP
PR: #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: #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: #350
File: modules/get-started/pages/cloud-overview.adoc:55-56
Timestamp: 2025-07-16T21:11:59.964Z
Learning: In the Redpanda Cloud documentation system using Asciidoctor, glossary cross-references with spaces in the ID (like glossterm:data plane[]) work correctly and do not need to be changed to hyphenated forms. The existing syntax is functional and should not be modified.
modules/shared/partials/feature-flag-agents.adoc (3)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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: #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: #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.
modules/develop/pages/connect/configuration/secret-management.adoc (1)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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.
modules/develop/pages/connect/configuration/resource-management.adoc (1)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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.
modules/develop/pages/agents/create-support-agent.adoc (1)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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.
modules/get-started/pages/whats-new-cloud.adoc (6)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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: #361
File: modules/networking/pages/cloud-security-network.adoc:193-196
Timestamp: 2025-07-21T21:53:37.669Z
Learning: In Redpanda Cloud documentation, field names and labels should match exactly what appears in the UI, even if the terminology might seem technically inconsistent. For example, the NAT gateway IP address field is labeled "Internet gateway" in the UI, so documentation should use "Internet gateway" to help users locate the correct field.
Learnt from: micheleRP
PR: #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: #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: #350
File: modules/get-started/pages/cloud-overview.adoc:55-56
Timestamp: 2025-07-16T21:11:59.964Z
Learning: In the Redpanda Cloud documentation system using Asciidoctor, glossary cross-references with spaces in the ID (like glossterm:data plane[]) work correctly and do not need to be changed to hyphenated forms. The existing syntax is functional and should not be modified.
Learnt from: micheleRP
PR: #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/security/partials/iam-policies.adoc (6)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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: #361
File: modules/networking/pages/cloud-security-network.adoc:193-196
Timestamp: 2025-07-21T21:53:37.669Z
Learning: In Redpanda Cloud documentation, field names and labels should match exactly what appears in the UI, even if the terminology might seem technically inconsistent. For example, the NAT gateway IP address field is labeled "Internet gateway" in the UI, so documentation should use "Internet gateway" to help users locate the correct field.
Learnt from: micheleRP
PR: #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.
Learnt from: micheleRP
PR: #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: #350
File: modules/get-started/pages/cloud-overview.adoc:55-56
Timestamp: 2025-07-16T21:11:59.964Z
Learning: In the Redpanda Cloud documentation system using Asciidoctor, glossary cross-references with spaces in the ID (like glossterm:data plane[]) work correctly and do not need to be changed to hyphenated forms. The existing syntax is functional and should not be modified.
Learnt from: micheleRP
PR: #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.
🧰 Additional context used
🧠 Learnings (8)
📓 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.037Z
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: 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#361
File: modules/networking/pages/cloud-security-network.adoc:193-196
Timestamp: 2025-07-21T21:53:37.669Z
Learning: In Redpanda Cloud documentation, field names and labels should match exactly what appears in the UI, even if the terminology might seem technically inconsistent. For example, the NAT gateway IP address field is labeled "Internet gateway" in the UI, so documentation should use "Internet gateway" to help users locate the correct field.
Learnt from: ncole
PR: redpanda-data/cloud-docs#356
File: modules/get-started/pages/cluster-types/byoc/azure/create-byoc-cluster-azure.adoc:101-118
Timestamp: 2025-07-16T18:50:06.882Z
Learning: In Azure documentation, when checking SKU restrictions with `az vm list-skus`, use the specific SKU size (e.g., Standard_D2d_v5) rather than the family name. However, for quota checking, family names are used. These serve different purposes in Azure resource management.
modules/manage/pages/terraform-provider.adoc (5)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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: #361
File: modules/networking/pages/cloud-security-network.adoc:193-196
Timestamp: 2025-07-21T21:53:37.669Z
Learning: In Redpanda Cloud documentation, field names and labels should match exactly what appears in the UI, even if the terminology might seem technically inconsistent. For example, the NAT gateway IP address field is labeled "Internet gateway" in the UI, so documentation should use "Internet gateway" to help users locate the correct field.
Learnt from: micheleRP
PR: #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: #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: #350
File: modules/get-started/pages/cloud-overview.adoc:55-56
Timestamp: 2025-07-16T21:11:59.964Z
Learning: In the Redpanda Cloud documentation system using Asciidoctor, glossary cross-references with spaces in the ID (like glossterm:data plane[]) work correctly and do not need to be changed to hyphenated forms. The existing syntax is functional and should not be modified.
modules/shared/partials/feature-flag-agents.adoc (3)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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: #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: #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.
modules/develop/pages/connect/configuration/secret-management.adoc (1)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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.
modules/develop/pages/connect/configuration/resource-management.adoc (1)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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.
modules/develop/pages/agents/create-support-agent.adoc (1)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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.
modules/get-started/pages/whats-new-cloud.adoc (6)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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: #361
File: modules/networking/pages/cloud-security-network.adoc:193-196
Timestamp: 2025-07-21T21:53:37.669Z
Learning: In Redpanda Cloud documentation, field names and labels should match exactly what appears in the UI, even if the terminology might seem technically inconsistent. For example, the NAT gateway IP address field is labeled "Internet gateway" in the UI, so documentation should use "Internet gateway" to help users locate the correct field.
Learnt from: micheleRP
PR: #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: #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: #350
File: modules/get-started/pages/cloud-overview.adoc:55-56
Timestamp: 2025-07-16T21:11:59.964Z
Learning: In the Redpanda Cloud documentation system using Asciidoctor, glossary cross-references with spaces in the ID (like glossterm:data plane[]) work correctly and do not need to be changed to hyphenated forms. The existing syntax is functional and should not be modified.
Learnt from: micheleRP
PR: #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/security/partials/iam-policies.adoc (6)
Learnt from: micheleRP
PR: #361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.037Z
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: #361
File: modules/networking/pages/cloud-security-network.adoc:193-196
Timestamp: 2025-07-21T21:53:37.669Z
Learning: In Redpanda Cloud documentation, field names and labels should match exactly what appears in the UI, even if the terminology might seem technically inconsistent. For example, the NAT gateway IP address field is labeled "Internet gateway" in the UI, so documentation should use "Internet gateway" to help users locate the correct field.
Learnt from: micheleRP
PR: #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.
Learnt from: micheleRP
PR: #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: #350
File: modules/get-started/pages/cloud-overview.adoc:55-56
Timestamp: 2025-07-16T21:11:59.964Z
Learning: In the Redpanda Cloud documentation system using Asciidoctor, glossary cross-references with spaces in the ID (like glossterm:data plane[]) work correctly and do not need to be changed to hyphenated forms. The existing syntax is functional and should not be modified.
Learnt from: micheleRP
PR: #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.
⏰ 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
🔇 Additional comments (6)
modules/develop/pages/connect/configuration/resource-management.adoc (1)
9-9: Terminology update looks correct
The combined notation “BYOVPC/BYOVNet” is the preferred form when a prerequisite applies across cloud providers. Good catch.modules/manage/pages/terraform-provider.adoc (1)
93-93: Accurate cloud-specific term
Replacing “BYOVPC” with “BYOVNet” for Azure clusters removes a misleading reference. ✅modules/develop/pages/connect/configuration/secret-management.adoc (1)
10-10: Consistent cluster exclusions
The prerequisite now excludes both BYOVPC and BYOVNet cluster types, matching other pages. Looks good.modules/security/partials/iam-policies.adoc (1)
863-866: Corrected link text for Azure BYOC docs
Switching to “BYOVNet” aligns with the Azure product name and prevents cross-provider confusion.modules/shared/partials/feature-flag-agents.adoc (1)
3-3: Exclusion list now complete
Adding “BYOVNet” ensures readers understand AI agents are unavailable on all bring-your-own-network cluster types. Good.modules/get-started/pages/whats-new-cloud.adoc (1)
60-62: Terminology update looks correct.Replacing BYOVPC with BYOVNet for Azure‐specific content aligns with the product naming convention and keeps the release note accurate. No further changes needed here.
|
nice ! |
Description
This pull request updates documentation to reflect a terminology change from "BYOVPC" to "BYOVNet" across multiple files.
modules/develop/pages/agents/create-support-agent.adoc: Updated prerequisite description to specify "BYOVNet" instead of "BYOVPC" for cluster types.modules/develop/pages/connect/configuration/resource-management.adoc: Changed cluster type references from "BYOVPC" to "BYOVNet" in the prerequisites section.modules/develop/pages/connect/configuration/secret-management.adoc: Adjusted cluster type references to include "BYOVNet" instead of "BYOVPC."modules/get-started/pages/whats-new-cloud.adoc: Updated feature description for Redpanda Connect to specify "BYOVNet" clusters on Azure instead of "BYOVPC."modules/manage/pages/terraform-provider.adoc: Changed references to cluster creation/deletion functionality from "BYOVPC" to "BYOVNet" for Azure clusters.modules/security/partials/iam-policies.adoc: Clarified IAM policy applicability, replacing "BYOVPC" with "BYOVNet" in Azure cluster references.modules/shared/partials/feature-flag-agents.adoc: Updated AI agent availability restrictions to include "BYOVNet" alongside "BYOVPC."Resolves https://redpandadata.atlassian.net/browse/DOC-1519
Review deadline:
Page previews
Checks