Skip to content

pd-ctl: add notice for member delete (#21374) #21386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ti-chi-bot merged 4 commits into from
Jul 14, 2025
Merged

pd-ctl: add notice for member delete (#21374) #21386

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
535e914
pd-ctl: add notice for `member delete`
Oreoxmt Jul 10, 2025
4ce571a
Apply suggestions from code review
Oreoxmt Jul 10, 2025
f351aca
Apply suggestions from code review
Oreoxmt Jul 10, 2025
1fd71fa
Apply suggestions from code review
Oreoxmt Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pd-control.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,10 @@ Usage:

### `member [delete | leader_priority | leader [show | resign | transfer <member_name>]]`

> **Note:**
>
> **DO NOT** use the `member delete` command to remove PD nodes in a production environment. To remove a PD node, see [Scale in a TiDB/PD/TiKV cluster](/scale-tidb-using-tiup.md#scale-in-a-tidbpdtikv-cluster) and [Manually Scale TiDB on Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/scale-a-tidb-cluster/).
Comment on lines +444 to +446
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jul 14, 2025

Choose a reason for hiding this comment

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

low

To improve the clarity and flow of this note, I suggest the following changes:

  • Use sentence case (Do not instead of **DO NOT**) for a more standard warning tone.
  • Connect the two sentences with Instead to improve the logical flow.
  • Use or instead of and because the linked documents describe alternative methods for different environments (TiUP vs. Kubernetes).
  • Use refer to instead of see for a slightly more formal tone.1

Style Guide References

Suggested change
> **Note:**
>
> **DO NOT** use the `member delete` command to remove PD nodes in a production environment. To remove a PD node, see [Scale in a TiDB/PD/TiKV cluster](/scale-tidb-using-tiup.md#scale-in-a-tidbpdtikv-cluster) and [Manually Scale TiDB on Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/scale-a-tidb-cluster/).
> **Note:**
>
> Do not use the `member delete` command to remove PD nodes in a production environment. Instead, to remove a PD node, refer to [Scale in a TiDB/PD/TiKV cluster](/scale-tidb-using-tiup.md#scale-in-a-tidbpdtikv-cluster) or [Manually Scale TiDB on Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/scale-a-tidb-cluster/).

Footnotes

  1. The documentation should prioritize clarity, simplicity, completeness, and readability. (link) ↩


Use this command to view the PD members, remove a specified member, or configure the priority of leader.

Usage:
Expand Down