Repository navigation
docs: use "node count" or "number of nodes" instead of "node number" (#24360) - #24476
Conversation
ti-chi-bot
added
lgtm
needs-1-more-lgtm
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation |
|---|---|---|
| Title check |  |
The title clearly and concisely describes the main documentation change: replacing “node number” with “node count” or “number of nodes.” |
| Description check | |
The description is complete. It explains the terminology change, affected files and anchors, applicable versions, AI involvement, and cherry-pick 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. |
Full details: Docstring Coverage
-
Explanation
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 files. (10 skipped: 10 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.
Comment @coderabbitai help to get the list of available commands.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🔇 Additional comments: 7
grafana-overview-dashboard.md: 1
20-20: LGTM!tidb-cloud/scalability-concepts.md: 1
30-30: LGTM!Also applies to: 36-36, 42-42
tidb-cloud/scale-tidb-cluster.md: 2
15-15: LGTM!Also applies to: 25-25, 35-35
29-29: 🎯 Functional CorrectnessThe heading change is already consistent with the in-repository links. No old
#change-node-numberreferences remain, and the two affected links use#change-node-count. The timed-out validation command does not establish a formatting or link failure, and the repository guidance lists Markdown validation as a habit rather than a required reported check.tidb-cloud/terraform-use-cluster-resource.md: 1
268-268: LGTM!tidb-cloud/tiproxy-management.md: 1
29-29: LGTM!tidb-cloud/releases/notification-2023-11-14-scale-feature-maintenance.md-22-22: 1
22-22: 📐 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.Use “cannot” instead of “can not”.
The changed sentence uses
can notwithout emphasis. Replace it withcannot.Committable suggestion
-During the maintenance window, [change vCPU and RAM](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-vcpu-and-ram) is disabled and you can not change vCPU and RAM for your Dedicated Clusters. However, you can still change the node count or storage in the Modify Cluster page. Your TiDB cluster will maintain its regular operations for data read and write, ensuring no adverse effects on your online business. +During the maintenance window, [change vCPU and RAM](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-vcpu-and-ram) is disabled and you cannot change vCPU and RAM for your Dedicated Clusters. However, you can still change the node count or storage in the Modify Cluster page. Your TiDB cluster will maintain its regular operations for data read and write, ensuring no adverse effects on your online business.Sources: Path instructions, Linters/SAST tools
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: pingcap/docs/.coderabbit.yaml
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
1432b0a1-385d-49b8-9441-464992e2daa9
📒 Files selected for processing: 10
functions-and-operators/group-by-modifier.mdgrafana-overview-dashboard.mdtidb-cloud/backup-and-restore.mdtidb-cloud/monitor-built-in-alerting.mdtidb-cloud/releases/notification-2023-11-14-scale-feature-maintenance.mdtidb-cloud/releases/release-notes-2023.mdtidb-cloud/scalability-concepts.mdtidb-cloud/scale-tidb-cluster.mdtidb-cloud/terraform-use-cluster-resource.mdtidb-cloud/tiproxy-management.md
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.
|
/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 |
3 participants
This is an automated cherry-pick of #24360
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