feat(doc): fold Azure into standard onboarding & make BYO-VPC self-service#6371
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
4 Skipped Deployments
|
|
|
b6b6ea2 to
4b9e06c
Compare
There was a problem hiding this comment.
Pull request overview
Updates ClickHouse Cloud BYOC documentation to reflect Azure moving into the standard self-service onboarding flow and to make GCP BYO‑VPC provisioning self-service via the console, aligning wording/UI steps across providers.
Changes:
- Removes the standalone Azure Private Preview onboarding page and drops it from the (en) guides index.
- Updates Standard onboarding / Architecture / Additional infrastructure docs with multi-cloud terminology (AWS/GCP/Azure).
- Reworks GCP customized (BYO‑VPC) onboarding to document the console “Set up Infrastructure” flow and adds a new screenshot; aligns AWS customized wording.
Reviewed changes
Copilot reviewed 9 out of 16 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/cloud/guides/infrastructure/01_deployment_options/byoc/08_reference/03_network_security.md | Frontmatter/table formatting tweaks; small structural changes to section labels. |
| docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/05_azure_private_preview.md | Removes the Azure Private Preview page. |
| docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/04_setup_a_new_region.md | Updates frontmatter + Azure subscription mention; adjusts stepper content. |
| docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/02_customization/02_gcp.md | Replaces support-ticket provisioning step with self-service console flow + new UI image. |
| docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/02_customization/01_aws.md | Aligns wording/casing with GCP flow; edits list formatting. |
| docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/02_customization/category.json | Adjusts category label casing. |
| docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/01_standard.md | Generalizes standard onboarding language for Azure and adds Azure Terraform module link. |
| docs/cloud/guides/infrastructure/01_deployment_options/byoc/02_architecture.md | Generalizes architecture language to include Azure; formatting adjustments. |
| docs/cloud/guides/index.md | Removes the Azure Private Preview row from the autogenerated (en) guides index. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
49d6757 to
1597b01
Compare
1597b01 to
767f9e2
Compare
|
Hi @luisliuchao let me know if you're ready to merge this? I can push some small formatting fixes to get the Vercel and DocsChecks green. |
767f9e2 to
0a92146
Compare
0a92146 to
e742aa3
Compare
|
@Blargian yes, it's ready for merge now |
|
@yiyang-shao, @luisliuchao BYOC docs are quite difficult to find currently. As part of the move to the new docs platform we will move these docs higher up in the navigation: https://private-7c7dfe99.mintlify.app/products/cloud/getting-started/cloud-get-started I will sync across all the changes to the new platform |
|
Docs PR opened: ClickHouse/mintlify-docs-dev#190 Folded Azure BYOC into standard onboarding flow, made BYO-VPC self-service for GCP, and removed the separate Azure private preview page. |
Summary
Updates the BYOC onboarding docs to reflect the Azure self-onboarding flow change. Azure now follows the same self-service console flow as AWS and GCP, rather than a separate manual/private-preview process.
Azure onboarding
Azure Private Previewonboarding page (05_azure_private_preview.md) and its link from the autogenerated guides index.GCP customized (BYO-VPC) setup
byoc-gcp-existing-vpc-ui.png).:::info/:::notecallout for the secondary-IPv4-range / contact-support edge case.Consistency & formatting
sidebar_label/labelcasings across BYOC reference pages.🤖 Generated with Claude Code
Note
Low Risk
Documentation and formatting only; no application code, auth, or data-path changes.
Overview
Documents now describe Azure BYOC using the same self-service Standard onboarding path as AWS and GCP: the dedicated Azure Private Preview page is removed from the guides index, and standard onboarding covers Azure subscriptions, VNet/AKS, and the Azure Terraform module alongside existing AWS/GCP steps. Architecture and additional infrastructure pages are updated for Azure subscription mixing and multi-account deployment.
GCP BYO-VPC customization no longer ends with a support ticket; it documents the console Set up BYOC infrastructure flow (aligned with AWS), including a new existing-VPC UI screenshot. Minor consistency edits cover UI labels, VPC/VNet CIDR minimum (
/23), sidebar casing, network-security table/formatting, and a new.prettierrcfor quote/trailing-comma style.Reviewed by Cursor Bugbot for commit f21fe6a. Bugbot is set up for automated code reviews on this repo. Configure here.