Repository navigation
docs: use "node count" or "number of nodes" instead of "node number" - #24360
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ti-chi-bot
Bot
added
missing-translation-status
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to This documentation update clarifies node-count wording without changing operational guidance, and the updated links resolve to the renamed section. No material merge risk is evident. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 3 systems. Changed systems: Architecture concerns Review details
Pre-merge checks ·
 |
| Check name | Status | Explanation |
|---|---|---|
| Title check |  |
The title clearly and concisely describes the primary documentation change: replacing ambiguous “node number” wording with “node count” or “number of nodes.” |
| Description check | |
The description is complete and explains the wording changes, affected files, anchor update, target TiDB versions, AI involvement, and related translation context. |
| 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. |
✨ 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.
Comment @coderabbitai help to get the list of available commands.
ti-chi-bot
Bot
removed
the
missing-translation-status
|
Marking as |
[LGTM Timeline notifier]Timeline:
|
qiancai
added
the
needs-cherry-pick-release-8.5
…y-concepts Keep "availability zones" from pingcap#24275 and "node count" from this PR. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
@qiancai: Your lgtm message is repeated, so it is ignored. DetailsIn response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
In response to a cherrypick label: new pull request created to branch |
3 participants
What is changed, added, or deleted? (Required)
Several docs use "node number" to mean the number of nodes, for example "Consider increasing the node number or node size for TiDB" and the heading "Change node number". "Node number" reads more naturally as a node's ID or ordinal position (node #1, node #2) than as a count. The section itself already says "You can increase or decrease the number of TiDB, TiKV, or TiFlash nodes".
The ambiguity has already caused mistranslations. The Japanese docs (
i18n-ja-release-8.5) render this phrase as 「ノード番号」 ("node ID / node ordinal") instead of 「ノード数」 ("number of nodes") in two places:functions-and-operators/group-by-modifier.mdL47: the link text[Change node number]became 「ノード番号を変更する」 ("change the node ID").tidb-cloud/releases/release-notes-2023.mdL901: "You can decrease the node number via the TiDB Cloud console" became 「ノード番号をTiDB Cloudコンソール経由…で減らすこと」 ("decrease the node ID via the TiDB Cloud console").Using "node count" or "number of nodes" in the English source removes the ambiguity for readers and for translation.
This PR replaces all 27 occurrences of "node number(s)" / "nodes number" in 10 files:
tidb-cloud/monitor-built-in-alerting.md(12),tidb-cloud/scalability-concepts.md(3),tidb-cloud/scale-tidb-cluster.md(5, including the heading),tidb-cloud/releases/notification-2023-11-14-scale-feature-maintenance.md,tidb-cloud/terraform-use-cluster-resource.md,tidb-cloud/tiproxy-management.md("node counts").tidb-cloud/backup-and-restore.md(2),tidb-cloud/releases/release-notes-2023.md,grafana-overview-dashboard.md("The number of online nodes of each service").Heading and anchor change:
## Change node numberintidb-cloud/scale-tidb-cluster.mdbecomes## Change node count, so the anchor changes from#change-node-numberto#change-node-count. The only two in-repo links to the old anchor (functions-and-operators/group-by-modifier.mdandtidb-cloud/releases/release-notes-2023.md) are updated in this PR. After this change, no occurrences of "node number" or#change-node-numberremain in the repository.The same text exists on
release-8.5with the same occurrence counts, so the cherry-pick should apply cleanly. The Japanese docs will pick up the change through the regular translation sync.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)?
AI agent involvement
Do your changes match any of the following descriptions?
🤖 Generated with Claude Code
Summary by CodeRabbit