Skip to content

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

Merged
ti-chi-bot[bot] merged 1 commit into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-24204-to-release-8.5
Oct 27, 2026
Merged

ti-chi-bot[bot] merged 1 commit into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-24204-to-release-8.5

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #24204

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

  • Documentation
    • Clarified the default estimated TiKV Region split size: 256 MiB for TiDB v8.4.0 and later, and 96 MiB for earlier versions.
    • The existing description of three-replica Raft groups and their scheduling across TiKV instances remains unchanged.

@ti-chi-bot ti-chi-bot added 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 ONCALL Relates to documentation oncall. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 27, 2026
@ti-chi-bot ti-chi-bot added type/bugfix This PR fixes a bug. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Oct 27, 2026
@coderabbitai

coderabbitai Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 934e83f and 3712a0c.

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 guide now specifies estimated Region split sizes by TiDB version: 256 MiB for v8.4.0 and later, and 96 MiB for earlier versions.

Changes: Region split size documentation

Layer / File(s) Summary
Document version-specific split sizes
multi-data-centers-in-one-city-deployment.md
The Region description specifies a 256 MiB estimated split size for TiDB v8.4.0 and later, and 96 MiB for earlier versions.

Priority: Low

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

Change: Bug fix

Possibly related PRs

  • pingcap/docs#24204: Changes the same document to replace the outdated Region size with 256 MiB.
  • pingcap/docs#24205: Updates the TiDB Cloud glossary with the same version-specific Region size.

Suggested reviewers: qiancai

Merge Risk: Minimal · up to 3712a

The deployment guidance update is limited in scope and presents no merge-blocking risk.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly identifies the documentation fix and the outdated Region size. It is concise and directly related to the main change.
Description check Passed The description includes the required change summary, affected versions, reference links, AI involvement, and change-type checklist. It explains the automated cherry-pick and the scope of the document…
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: Description check

Explanation

The description includes the required change summary, affected versions, reference links, AI involvement, and change-type checklist. It explains the automated cherry-pick and the scope of the documentation update.

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
🧪 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.

❤️ Share

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

@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 assigned lilin90 and unassigned doc-claw-bot Oct 27, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 3896b91 into pingcap:release-8.5 Oct 27, 2026
12 checks passed
@ti-chi-bot
ti-chi-bot Bot deleted the cherry-pick-24204-to-release-8.5 branch October 27, 2026 09:19
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 ONCALL Relates to documentation oncall. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/bugfix This PR fixes a bug. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants