byoc: add architecture descriptions by wildpcww · Pull Request #23280 · pingcap/docs

wildpcww · 2026-07-15T07:35:17Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

What is the related PR or file link(s)?

This PR is translated from:
Other reference link(s):

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

Summary by CodeRabbit

Documentation
- Updated architecture documentation formatting for improved consistency and readability.
- Clarified the BYOC architecture as a split-plane model, with the control plane managed by PingCAP and the data plane running in the customer’s cloud account.
- Updated the BYOC architecture link in the TiDB Cloud introduction to point to the new architecture concepts page.

gemini-code-assist

Code Review

This pull request introduces documentation for TiDB Cloud BYOC (Bring Your Own Cloud), adding a detailed architecture section in architecture-concepts.md and updating the onboarding overview in byoc-onboarding-overview.md to link to it. The review feedback focuses on aligning the new content with the style guide by preferring active voice, writing in the second person, maintaining consistent capitalization in lists, removing redundant paragraphs, and using relative paths for internal links.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

coderabbitai · 2026-07-21T07:18:26Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: b4697629-99af-40d1-a5cf-7b08047fff4d

📥 Commits

Reviewing files that changed from the base of the PR and between 8ca75c9 and 689e4af.

📒 Files selected for processing (2)

tidb-cloud/architecture-concepts.md
tidb-cloud/tidb-cloud-intro.md

📝 Walkthrough

Walkthrough

The PR normalizes TiDB Cloud architecture documentation formatting, updates the BYOC onboarding overview to describe the split-plane architecture, and redirects BYOC references to the architecture concepts documentation.

Changes

TiDB Cloud documentation

Layer / File(s)	Summary
Architecture content formatting `tidb-cloud/architecture-concepts.md`	Markdown metadata, plan descriptions, deployment options, node documentation, and Premium capacity sections were reflowed and consistently indented without changing their documented content.
BYOC split-plane documentation `tidb-cloud/byoc/byoc-onboarding-overview.md`, `tidb-cloud/tidb-cloud-intro.md`	The onboarding overview now describes PingCAP-managed control plane and customer-cloud data plane ownership, while the BYOC links point to the architecture concepts documentation.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: area/tidb-cloud

Suggested reviewers: qiancai, lilin90

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The template is present, but the required change summary is empty and the related links section is not filled in.	Add a concrete summary of what changed and why, and include any relevant PR or file links.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: adding BYOC architecture descriptions.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 623fedc7-dff7-451b-a726-dcf2cc33c3dc

📥 Commits

Reviewing files that changed from the base of the PR and between c874202 and 8ca75c9.

📒 Files selected for processing (2)

tidb-cloud/architecture-concepts.md
tidb-cloud/byoc/byoc-onboarding-overview.md

coderabbitai · 2026-07-21T07:21:58Z

+
+<CustomContent language="en,zh">
+
+TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings the flexibility and power of [TiDB](https://docs.pingcap.com/tidb/stable/overview), an open-source HTAP (Hybrid Transactional and Analytical Processing) database, to Amazon Web Services (AWS), Google Cloud, Microsoft Azure, and Alibaba Cloud.


📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Remove the hyphen from “fully managed.”

Vale reports this wording as incorrect in both language blocks. Use “fully managed Database-as-a-Service” on Line 10 and Line 16.

Also applies to: 16-16

🧰 Tools

🪛 GitHub Check: vale

[failure] 10-10:
[vale] reported by reviewdog 🐶
[PingCAP.LyHyphens] ' fully-' doesn't need a hyphen.

Raw Output:
{"message": "[PingCAP.LyHyphens] ' fully-' doesn't need a hyphen.", "location": {"path": "tidb-cloud/architecture-concepts.md", "range": {"start": {"line": 10, "column": 16}}}, "severity": "ERROR"}

Source: Linters/SAST tools

ti-chi-bot · 2026-07-21T07:31:18Z

[LGTM Timeline notifier]

Timeline:

2026-07-21 07:31:18.611397314 +0000 UTC m=+1303664.647492370: ☑️ agreed by lilin90.

lilin90 · 2026-07-21T07:35:03Z

/approve

ti-chi-bot · 2026-07-21T07:35:12Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilin90

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [lilin90]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

byoc-archetecture

460c688

ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 15, 2026

gemini-code-assist Bot reviewed Jul 15, 2026

View reviewed changes

Comment thread tidb-cloud/architecture-concepts.md

Comment thread tidb-cloud/architecture-concepts.md

Comment thread tidb-cloud/architecture-concepts.md Outdated

Comment thread tidb-cloud/byoc/byoc-onboarding-overview.md Outdated

lilin90 self-assigned this Jul 20, 2026

lilin90 added BYOC Related to TiDB Cloud BYOC docs. translation/no-need No need to translate this PR. labels Jul 20, 2026

ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jul 20, 2026

lilin90 changed the title ~~byoc-architecture~~ byoc: add architecture desciptions Jul 20, 2026

lilin90 changed the title ~~byoc: add architecture desciptions~~ byoc: add architecture descriptions Jul 20, 2026

Merge branch 'release-8.5' into pr/23280

8ca75c9

coderabbitai Bot reviewed Jul 21, 2026

View reviewed changes

Refine wording and update cloud intro

689e4af

lilin90 reviewed Jul 21, 2026

View reviewed changes

Comment thread tidb-cloud/byoc/byoc-onboarding-overview.md Outdated

lilin90 reviewed Jul 21, 2026

View reviewed changes

Comment thread tidb-cloud/architecture-concepts.md Outdated

Update wording and link

adfc19a

lilin90 approved these changes Jul 21, 2026

View reviewed changes

ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 21, 2026

lilin90 added the lgtm label Jul 21, 2026

ti-chi-bot Bot added the approved label Jul 21, 2026

ti-chi-bot Bot merged commit 60bb3ac into pingcap:release-8.5 Jul 21, 2026
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

byoc: add architecture descriptions#23280

byoc: add architecture descriptions#23280
ti-chi-bot[bot] merged 4 commits into
pingcap:release-8.5from
wildpcww:byoc-architecture

wildpcww commented Jul 15, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot commented Jul 21, 2026 •

edited

Loading

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Jul 21, 2026

Uh oh!

Uh oh!

Uh oh!

ti-chi-bot Bot commented Jul 21, 2026

Uh oh!

lilin90 commented Jul 21, 2026

Uh oh!

ti-chi-bot Bot commented Jul 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		<CustomContent language="en,zh">

		TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings the flexibility and power of [TiDB](https://docs.pingcap.com/tidb/stable/overview), an open-source HTAP (Hybrid Transactional and Analytical Processing) database, to Amazon Web Services (AWS), Google Cloud, Microsoft Azure, and Alibaba Cloud.

Uh oh!

Conversation

wildpcww commented Jul 15, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

Summary by CodeRabbit

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot commented Jul 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ti-chi-bot Bot commented Jul 21, 2026

[LGTM Timeline notifier]

Uh oh!

lilin90 commented Jul 21, 2026

Uh oh!

ti-chi-bot Bot commented Jul 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

wildpcww commented Jul 15, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 21, 2026 •

edited

Loading