Repository navigation
Conversation
lilin90
added
translation/no-need
|
Skipping CI for Draft Pull Request. |
ti-chi-bot
Bot
added
the
do-not-merge/work-in-progress
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
Bot
added
the
size/M
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 Walkthrough
Merge Risk: 🔵 Low · up to
|
| Check name | Status | Explanation |
|---|---|---|
| Docstring Coverage |  |
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0… |
| Linked Issues check | |
Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | |
Check skipped because no linked issues were found for this pull request. |
| Title check | |
The title clearly identifies the BYOC and shared-content updates. The wording is concise and related to the main changes. |
| Description check | |
The description includes the required change summary and identifies v8.5 as the affected version. Optional reference links are empty, but the description is otherwise complete and relevant. |
✨ Finishing Touches 💡 1
-
🛠️ Fix failing CI checks 💡
-
- Commit to this branch
- Create a new PR
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
Comment @coderabbitai help to get the list of available commands.
Update two TiDB Cloud Premium docs to consistently cover both Premium and BYOC instances. This revises page titles/summaries, replaces conditional plan-specific text with shared wording, and cleans up repeated references across backup/restore and AWS PrivateLink guidance. It also updates one pricing link label for clarity.
ti-chi-bot
Bot
added
size/L
Update seven TiDB Cloud Premium docs to consistently state support for both {{{ .premium }}} and {{{ .byoc }}} instances in titles, summaries, headings, and body text. This also replaces several inline plan-specific CustomContent fragments with direct wording for readability, and refines CSV import descriptions to clarify that Amazon S3 applies to both plans while Alibaba Cloud OSS remains Premium-only.
ti-chi-bot
Bot
added
size/XL
lilin90
changed the title
ti-chi-bot
Bot
removed
the
do-not-merge/work-in-progress
|
@coderabbitai help |
There was a problem hiding this comment.
🟡 Changes recommended
Several pages advertise BYOC support while retaining Premium-only procedures or headings, and the BYOC navigation remains stale.
7 open findings
What changed in this PR
Makes BYOC information publicly visible across shared TiDB Cloud documentation and broadens Premium procedures to cover BYOC.
Changes:
- Removes selected BYOC-only content gates.
- Expands shared Premium/BYOC task documentation.
- Updates BYOC preview status and feature references.
| File | Description |
|---|---|
tidb-cloud/tidb-cloud-support.md |
Exposes BYOC support-plan requirements. |
tidb-cloud/tidb-cloud-intro.md |
Publishes BYOC overview and architecture note. |
tidb-cloud/tidb-cloud-billing.md |
Exposes BYOC pricing guidance. |
tidb-cloud/statement-insight.md |
Broadens availability wording to BYOC. |
tidb-cloud/select-cluster-tier.md |
Exposes BYOC plan information. |
tidb-cloud/premium/tidb-cloud-auditing-premium.md |
Extends auditing guidance to BYOC. |
tidb-cloud/premium/premium-export.md |
Extends export guidance to BYOC. |
tidb-cloud/premium/import-from-s3-premium.md |
Adds BYOC to S3 import scope. |
tidb-cloud/premium/import-csv-files-premium.md |
Adds BYOC to S3 import scope. |
tidb-cloud/premium/delete-tidb-instance.md |
Extends deletion guidance to BYOC. |
tidb-cloud/premium/connect-to-tidb-instance.md |
Broadens connection overview to BYOC. |
tidb-cloud/premium/connect-to-premium-via-public-connection.md |
Extends public-connection guidance. |
tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md |
Extends PrivateLink guidance. |
tidb-cloud/premium/backup-and-restore-premium.md |
Consolidates Premium/BYOC backup guidance. |
tidb-cloud/manage-projects-and-resources.md |
Exposes BYOC resource and creation links. |
tidb-cloud/data-pipeline.md |
Publishes shared BYOC pipeline references. |
tidb-cloud/data-pipeline-lake-faq.md |
Broadens latency guidance to BYOC. |
tidb-cloud/backup-and-restore-concepts.md |
Exposes BYOC backup concepts. |
tidb-cloud/architecture-concepts.md |
Publishes BYOC architecture details. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Updated the restore instructions to include BYOC instances. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…into byoc-preview-updates
|
@wildpcww Please review changes in this PR. Thanks! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔇 Additional comments (10)
tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md (1)
2-3: LGTM!Also applies to: 6-6, 8-8, 30-30, 38-38, 44-44, 50-50, 59-59, 91-91, 109-109, 113-113, 135-135, 175-175, 197-197, 216-216
tidb-cloud/premium/connect-to-premium-via-public-connection.md (1)
2-2: LGTM!Also applies to: 6-6, 8-8, 25-25, 29-29, 79-79
tidb-cloud/premium/connect-to-tidb-instance.md (1)
2-3: LGTM!Also applies to: 6-6, 8-8, 16-16, 26-26, 34-34, 46-46
tidb-cloud/tidb-cloud-intro.md (1)
127-127: 🎯 Functional CorrectnessThe AWS BYOC availability status for release-8.5 cannot be decided from the available evidence. The repository shows the wording change, but no authoritative source confirms when BYOC entered public preview. The available web results do not establish this status.
tidb-cloud/premium/delete-tidb-instance.md (1)
28-28: 🎯 Functional CorrectnessThe concern is refuted.
🔒means “In private preview,” not unavailable;❌denotes “Currently not available.” The backup documentation also explicitly includes BYOC Recycle Bin backups and restoration instructions, so the BYOC wording on lines 28 and 36 is supported.tidb-cloud/data-pipeline-lake-faq.md (1)
22-22: LGTM!tidb-cloud/data-pipeline.md (1)
57-57: LGTM!Also applies to: 65-65, 75-75, 86-86, 90-90, 107-107
tidb-cloud/premium/import-from-s3-premium.md (1)
2-2: LGTM!Also applies to: 3-3, 6-6, 8-8, 17-17, 23-23, 28-28, 36-36, 40-40, 45-45, 55-55, 77-77
tidb-cloud/premium/premium-export.md (1)
2-2: LGTM!Also applies to: 3-3, 6-6, 8-8, 10-10, 12-12, 18-18, 36-36, 103-103, 108-108, 129-129, 134-134, 153-153, 158-158, 179-179
tidb-cloud/premium/connect-to-premium-via-public-connection.md-3-3 (1)
3-3: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
⚠️ Unverified finding
Verification ran but could not confirm this finding. It is shown for review, not as a verified issue.Add “instance” to the summary.
The summary says “your BYOC” without a noun. The title and introduction use “instance.”
summary: Learn how to connect to your {{{ .premium }}} or {{{ .byoc }}} instance via public connection.As per path instructions: “For every actionable issue, provide a GitHub committable suggestion block containing the exact replacement text whenever the fix can be safely and completely applied to contiguous lines in the diff.”
Source: Path instructions
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: pingcap/docs/.coderabbit.yaml
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
120d35cf-eb49-4914-a03e-5c58c9050b1c
📒 Files selected for processing (21)
TOC-tidb-cloud-byoc.mdtidb-cloud/architecture-concepts.mdtidb-cloud/backup-and-restore-concepts.mdtidb-cloud/data-pipeline-lake-faq.mdtidb-cloud/data-pipeline.mdtidb-cloud/manage-projects-and-resources.mdtidb-cloud/premium/backup-and-restore-premium.mdtidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.mdtidb-cloud/premium/connect-to-premium-via-public-connection.mdtidb-cloud/premium/connect-to-tidb-instance.mdtidb-cloud/premium/delete-tidb-instance.mdtidb-cloud/premium/import-csv-files-premium.mdtidb-cloud/premium/import-from-s3-premium.mdtidb-cloud/premium/import-with-mysql-cli-premium.mdtidb-cloud/premium/premium-export.mdtidb-cloud/premium/tidb-cloud-auditing-premium.mdtidb-cloud/select-cluster-tier.mdtidb-cloud/statement-insight.mdtidb-cloud/tidb-cloud-billing.mdtidb-cloud/tidb-cloud-intro.mdtidb-cloud/tidb-cloud-support.md
💤 Files with no reviewable changes (4)
- tidb-cloud/tidb-cloud-billing.md
- tidb-cloud/tidb-cloud-support.md
- tidb-cloud/architecture-concepts.md
- tidb-cloud/select-cluster-tier.md
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
| @@ -48,7 +56,7 @@ Because CSV files do not contain schema information, before importing data from | |||
|
|
|||
| Each database schema file must be in the `${db_name}-schema-create.sql` format and contain a `CREATE DATABASE` DDL statement. With this file, {{{ .premium }}} will create the `${db_name}` database to store your data when you import the data. | |||
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🔎 Supported by static analysis
🏁 Script executed:
git diff --unified=6 98a43e43b8d02b1c0a405d0332dadbd055612466 89ff1d8e083e01dcf562fc2107d11e8a9885d75c -- tidb-cloud/premium/import-csv-files-premium.md tidb-cloud/premium/import-with-mysql-cli-premium.md
nl -ba tidb-cloud/premium/import-csv-files-premium.md | sed -n '48,74p;80,105p;145,158p'
nl -ba tidb-cloud/premium/import-with-mysql-cli-premium.md | sed -n '8,24p'Repository: pingcap/docs
Length of output: 27382
Make the remaining import scope explicit.
BYOC supports Amazon S3 imports, but not Alibaba Cloud OSS imports. Qualify the schema-file instructions by provider instead of adding BYOC unconditionally. The scan step is Amazon S3-only, so it should name both plans. Also update the prerequisite link and text.
Suggested CSV guide updates
- Each database schema file must be in the `${db_name}-schema-create.sql` format and contain a `CREATE DATABASE` DDL statement. With this file, {{{ .premium }}} will create the `${db_name}` database to store your data when you import the data.
+ Each database schema file must be in the `${db_name}-schema-create.sql` format and contain a `CREATE DATABASE` DDL statement. With this file, {{{ .premium }}} will create the `${db_name}` database to store your data when you import the data. For imports from Amazon S3, {{{ .byoc }}} will also create the `${db_name}` database.
...
- If you do not include the table schema files in the Amazon S3 or Alibaba Cloud Object Storage Service directory where the CSV files are located, {{{ .premium }}} will not create the corresponding tables for you when you import the data.
+ If you do not include the table schema files in the Amazon S3 or Alibaba Cloud Object Storage Service directory where the CSV files are located, {{{ .premium }}} will not create the corresponding tables for you when you import the data. For imports from Amazon S3, {{{ .byoc }}} will also not create the corresponding tables.
...
- Each table schema file must be in the `${db_name}.${table_name}-schema.sql` format and contain a `CREATE TABLE` DDL statement. With this file, {{{ .premium }}} will create the `${table_name}` table in the `${db_name}` database when you import the data.
+ Each table schema file must be in the `${db_name}.${table_name}-schema.sql` format and contain a `CREATE TABLE` DDL statement. With this file, {{{ .premium }}} will create the `${table_name}` table in the `${db_name}` database when you import the data. For imports from Amazon S3, {{{ .byoc }}} will also create the `${table_name}` table.
...
-6. {{{ .premium }}} automatically scans the source path. Review the scan results, check the data files found and corresponding target tables, and then click **Start Import**.
+6. {{{ .premium }}} or {{{ .byoc }}} automatically scans the source path. Review the scan results, check the data files found and corresponding target tables, and then click **Start Import**.Suggested MySQL CLI guide updates
-> - Logical imports are best suited for relatively small SQL or CSV files. For faster, parallel imports from cloud storage or to process multiple files from [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) exports, see [Import CSV Files from Cloud Storage into {{{ .premium }}}](/tidb-cloud/premium/import-csv-files-premium.md).
+> - Logical imports are best suited for relatively small SQL or CSV files. For faster, parallel imports from cloud storage or to process multiple files from [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) exports, see [Import CSV Files from Cloud Storage into {{{ .premium }}} or {{{ .byoc }}}](/tidb-cloud/premium/import-csv-files-premium.md).
...
-Before you can import data to a {{{ .premium }}} instance via the MySQL Command-Line Client, you need the following prerequisites:
+Before you can import data to a {{{ .premium }}} or {{{ .byoc }}} instance via the MySQL Command-Line Client, you need the following prerequisites:
ChatThere are 3 ways to chat with CodeRabbit:
CodeRabbit commands
Other keywords and placeholders
Status, support, documentation and community
|
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to GitHub limitations.
🟡 Minor · Provide a BYOC-specific IP access-list guide. · connect-to-premium-via-public-connection.md:25
tidb-cloud/premium/connect-to-premium-via-public-connection.md:25
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winProvide a BYOC-specific IP access-list guide.
The link sends BYOC readers to a guide that states it applies only to Premium and provides Premium-specific steps. Link to a BYOC-capable guide, or update the target guide's applicability and instructions to cover BYOC.
Source: Path instructions
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: pingcap/docs/.coderabbit.yaml
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
49caf26a-7d6b-4aeb-91a5-9f9876fdf685
📒 Files selected for processing (6)
tidb-cloud/changefeed-overview.mdtidb-cloud/changefeed-sink-to-mysql.mdtidb-cloud/premium/backup-and-restore-premium.mdtidb-cloud/premium/connect-to-premium-via-public-connection.mdtidb-cloud/security-overview.mdtidb-cloud/tidb-cloud-log-redaction.md
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
ti-chi-bot
Bot
added
size/XXL
There was a problem hiding this comment.
Actionable comments posted: 4
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: pingcap/docs/.coderabbit.yaml
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
b8e33e9f-f445-4cb4-83ab-00c78a91e713
📒 Files selected for processing (13)
tidb-cloud/changefeed-overview.mdtidb-cloud/changefeed-sink-to-apache-kafka.mdtidb-cloud/changefeed-sink-to-mysql.mdtidb-cloud/premium/backup-and-restore-premium.mdtidb-cloud/premium/connect-to-premium-via-public-connection.mdtidb-cloud/premium/delete-tidb-instance.mdtidb-cloud/premium/import-csv-files-premium.mdtidb-cloud/premium/import-with-mysql-cli-premium.mdtidb-cloud/premium/premium-export.mdtidb-cloud/premium/set-up-sink-private-endpoint-premium.mdtidb-cloud/premium/tidb-cloud-auditing-premium.mdtidb-cloud/security-overview.mdtidb-cloud/tidb-cloud-log-redaction.md
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
This change expands the IP access list documentation to cover both Premium and BYOC instances. It clarifies the public endpoint requirements for BYOC deployments and updates the instructions to reflect the correct networking flow for enabling public access and adding allowed IPs.
lilin90
changed the title
What is changed, added, or deleted? (Required)
CustomContentand content shared by BYOC & PremiumCustomContentpublic on the pages of all cloud plansWhich 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)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit