Skip to content

docs: improve OpenTenBase introduction in quick start - #72

Open
niniland369 wants to merge 1 commit into
OpenTenBase:mainfrom
niniland369:docs/improve-quickstart-intro
Open

niniland369 wants to merge 1 commit into
OpenTenBase:mainfrom
niniland369:docs/improve-quickstart-intro

Conversation

@niniland369

Copy link
Copy Markdown

改动内容

优化「快速入门 → 什么是 OpenTenBase」引言段的表达:拆分长句、补齐术语解释、明确 CN/DN 的查询链路、消除与英文版及本站其他文档的不一致。

  • 文件:docs/guide/01-quickstart.md
  • 范围:仅引言第一段(+10 / -1),不改变任何技术原意,不涉及命令或配置

修改动机

该段是全站新手最先读到的文字,原文存在:

  1. 「配置一台或者多台主机上」漏字;
  2. 前句「一台或多台」与后句「多台物理主机」矛盾;
  3. distributed / replicated 裸抛且无解释,与 03-basic-use.md 的「分片表 / 复制表」叫法不一致;
  4. 查询链路省略 CN,易被理解为客户端直连 DN;
  5. 「多主节点」与英文版 multi node 不符。

技术依据(均为仓库内)

  • CN/DN 分工:01-quickstart.md:13-19
  • 分布键与分片:03-basic-use.md:16
  • 复制表全量数据、distribute by replication:03-basic-use.md:104, 112, 143
  • 术语与英文版对齐:01-quickstart.en.md:5

验证

  • 技术原意逐条对照上述依据,附于交付说明第五节
  • 按 docs/contribution/docs-format-guide.md 完成格式自检
  • 站内相对链接 03-basic-use.md 已确认存在
  • 本地 mkdocs build 生成的页面中,改写段落与链接 ../03-basic-use/ 均正确渲染
  • 待另一组试读反馈

备注

「写可靠性」在仓库内暂无进一步定义,本次保留原词未作解释,建议后续补充。

Split the long opening paragraph, explain distributed/replicated with in-repo references, clarify the CN to DN query path, and align the wording with the English version. No technical meaning changed.
@CLAassistant

CLAassistant commented Nov 7, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants