Skip to content

docs: fix outdated Region size in multi-AZ deployment doc - #24204

Merged
ti-chi-bot[bot] merged 5 commits into
pingcap:masterfrom
doc-claw-bot:docs/fix-region-default-multi-az
Oct 27, 2026
Merged

ti-chi-bot[bot] merged 5 commits into
pingcap:masterfrom
doc-claw-bot:docs/fix-region-default-multi-az

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

  • Update multi-data-centers-in-one-city-deployment.md to use the current default Region size (256 MiB) instead of the outdated 96 MB.
  • Keep the change scoped to the stale statement so the deployment guidance stays aligned with the current TiKV default used elsewhere in the docs.

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.

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

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

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

Summary by CodeRabbit

  • Documentation
    • Clarified the estimated default size of a newly split Region: 256 MiB for TiDB v8.4.0 and later, and 96 MiB for earlier versions.
    • The existing description of Region replicas remains unchanged.

@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. labels Oct 7, 2026
@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 7, 2026
@coderabbitai

coderabbitai Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: pingcap/docs
  • Branch: master
  • File: .coderabbit.yaml
  • Commit: 6ba8576
  • Layers: Repository YAML
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: bada636d-d138-48b3-b361-55476cab5b69
Commits

Reviewing files that changed from the base of the PR and between ab3b169 and 07d693f.

Files selected for processing: 1
  • multi-data-centers-in-one-city-deployment.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.

Walkthrough

The deployment documentation states that newly split Regions have an estimated default size of 256 MiB in TiDB v8.4.0 and later, and 96 MiB in earlier versions.

Changes: Region Size Documentation

Layer / File(s) Summary
Update documented Region size
multi-data-centers-in-one-city-deployment.md
The documentation specifies a 256 MiB estimated default for newly split Regions in TiDB v8.4.0 and later, and 96 MiB for earlier versions.

Priority: Low

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

Change: Other

Possibly related PRs

  • pingcap/docs#24205: Updates the TiDB Cloud glossary with the same version-dependent estimated default size for newly split Regions.

Suggested reviewers: qiancai

Merge Risk: Minimal · previous review 07d69

This documentation update is ready to merge; no material correctness or operational risk remains.

Architecture risk: Low · up to 75a0a

The change affects 1 system.

Changed systems: multi-data-centers-in-one-city-deployment.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — multi-data-centers-in-one-city-deployment.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in multi-data-centers-in-one-city-deployment.md: The documented default Region size changes from 96 MB to 256 MiB.
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly identifies the documentation file and the outdated Region size correction.
Description check Passed The description explains the change, affected TiDB versions, related references, AI involvement, and applicable change categories. The required sections are present and sufficiently complete.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi…
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.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches: 💡 1
⚔️ Resolve merge conflicts: 💡
  • Resolve merge conflict in branch docs/fix-region-default-multi-az
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autopilot · 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.

❤️ Share

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

@doc-claw-bot doc-claw-bot added type/bugfix This PR fixes a bug. area/deploy-upgrade-maintain Indicates that the Issue or PR belongs to the area of deployment, upgrade, and maintenance. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed missing-translation-status This PR does not have translation status info. labels Oct 7, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: f7ae5166-44a7-45d7-879e-e9c7baa451ed
📥 Commits

Reviewing files that changed from the base of the PR and between 6ba8576 and 75a0a4a.

📒 Files selected for processing (1)
  • multi-data-centers-in-one-city-deployment.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.

Comment thread multi-data-centers-in-one-city-deployment.md Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@lilin90 lilin90 self-assigned this Oct 27, 2026
@lilin90 lilin90 added the ONCALL Relates to documentation oncall. label Oct 27, 2026
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Oct 27, 2026
@lilin90
lilin90 requested a review from qiancai October 27, 2026 07:42
Comment thread multi-data-centers-in-one-city-deployment.md Outdated

@qiancai qiancai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rest LGTM

@ti-chi-bot ti-chi-bot Bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Oct 27, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 27, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-10-27 07:42:03.886104829 +0000 UTC m=+447261.377817108: ☑️ agreed by lilin90.
  • 2026-10-27 08:48:21.267010499 +0000 UTC m=+451238.758722759: ☑️ agreed by qiancai.

Co-authored-by: Grace Cai <qqzczy@126.com>

@lilin90 lilin90 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@ti-chi-bot

ti-chi-bot Bot commented Oct 27, 2026

Copy link
Copy Markdown

[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:

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

@ti-chi-bot ti-chi-bot Bot added the approved label Oct 27, 2026
@lilin90

lilin90 commented Oct 27, 2026

Copy link
Copy Markdown
Member

/hold

@ti-chi-bot ti-chi-bot Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 27, 2026
Comment thread multi-data-centers-in-one-city-deployment.md Outdated

@lilin90 lilin90 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/unhold

@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 27, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit d5bfd5d into pingcap:master Oct 27, 2026
12 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #24557.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/deploy-upgrade-maintain Indicates that the Issue or PR belongs to the area of deployment, upgrade, and maintenance. contribution This PR is from a community contributor. lgtm needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. ONCALL Relates to documentation oncall. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/bugfix This PR fixes a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants