pingcap / pingcap/docs

dm-best-practices.md: deployment table uses "1~N DM-worker nodes" without defining N

Open Beginner friendly
#23,744 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

What is affected

dm/dm-best-practices.md (English source, release-8.5 branch and likely master), in the deployment-plan recommendation table:

Deploy 1~N DM-worker nodes according to the number of upstream data sources. Generally, 1 DM-worker node is recommended.

N is used but never defined anywhere in the surrounding text or table. A reader has no way to know what N refers to (e.g., "the number of upstream data sources" is stated as the basis for the count, but it's not explicitly tied back to the N symbol).

Suggested fix

Clarify what N represents, e.g.:

Deploy 1 to N DM-worker nodes, where N is the number of upstream data sources. Generally, 1 DM-worker node is recommended.

Context

Found while reviewing CodeRabbit feedback on a Japanese translation PR (pingcap/docs#23635) — the JA translation faithfully mirrors this same ambiguity from the EN source, so per this repo's translation convention the fix belongs here in the EN source, not in the JA-only PR.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open dm/dm-best-practices.md on the release-8.5 branch and locate the deployment-plan recommendation table. Clarify that N is the number of upstream data sources, then check the surrounding English text and table for consistent wording. Done means the deployment range is unambiguous without changing the Japanese translation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
92/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.