pingcap / pingcap/docs

Possible mistranslation: "different TiDB nodes" in dev-guide-hybrid-oltp-and-olap-queries.md

Open Beginner friendly
#23,684 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

Error Report

  1. What is the URL/path of the document related to this issue?

https://github.com/pingcap/docs/blob/master/develop/dev-guide-hybrid-oltp-and-olap-queries.md

The current English text (release-8.5/master) says:

Note that TiFlash and TiKV storage engines usually use different TiDB nodes, so the two query types are not affected by each other.

  1. How would you like to improve it?

The corresponding Chinese source (docs-cn, same file) says:

需要指出的是,因为 tiflash 和 tikv 存储引擎通常属于不同的计算节点,所以两种查询类型互相之间不受影响。

"计算节点" is a generic term meaning "compute node(s)" — it does not refer to the TiDB (SQL layer) component specifically. TiFlash and TiKV are storage-layer components; they do not run on "TiDB nodes" architecturally, so the current English wording appears to be a mistranslation that introduces an inaccurate technical claim.

The sentence should say that TiFlash and TiKV usually run on different (compute) nodes — not "different TiDB nodes". Possible rewordings:

  • "...TiFlash and TiKV storage engines usually use different nodes, so..."
  • "...TiFlash and TiKV storage engines usually run on different compute nodes, so..."

Filing this as an issue rather than a PR since I'm not fully certain which exact wording best matches the intended meaning — happy to open a PR once the wording is confirmed.

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

Compare develop/dev-guide-hybrid-oltp-and-olap-queries.md with the corresponding docs-cn file, focusing on the sentence about TiFlash and TiKV storage engines. Confirm the intended translation for 计算节点 with a maintainer, then update the English wording and verify that the sentence accurately describes the architecture.

Written by the indexing model from the issue text.

Assessment

Domain
databases, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.