Repository navigation
Conversation
|
|
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR:新增《SQL 入门手册》——为 3 条基础 SQL 补充逐句解释
这个 PR 做了什么
新增一页面向第一次接触 OpenTenBase 的读者文档,从既有文档
docs/guide/03-basic-use.md中选取 3 条最基础的 SQL 示例,按「建表 → 写入 → 查询」的学习顺序补充用途说明、逐行解释、预期结果和小练习,并给出与源文档的逐条核对表。同时提供英文版(仓库要求
*.en.md同目录存放),并在mkdocs.yml中挂到「用户指南 → OpenTenBase」下、紧跟「快速入门」,以及英文nav_translations。变更文件
docs/guide/24-sql-primer.mddocs/guide/24-sql-primer.en.mdmkdocs.yml为什么是这 3 条
CREATE TABLE ... distribute by replication(分布方式)、INSERT(写入)、SELECT ... explain(查询与路由),正好是新手的第一个闭环。03-basic-use.md,读者读完本文可以顺势读原文,不用跳来跳去。与题目要求的对应
展示方式:一个新手原本不易理解的例子
原文对建表语法的说明是两句长句,同时出现「分布键」「节点」「存储组」三个概念,读完仍不知道三者的关系。本文第 5 节把它拆成:
warning明确「别把类比当技术事实」验证记录
已执行的检查:
distribute by shard语义、INSERT 0 2、Node/s: dn001、分布键不可更新,均与03-basic-use.md一致(见正文第 7 节)OpenTenBase/docs后按本 PR 修改mkdocs.yml,用mkdocs-material+mkdocs-static-i18n构建,zh与en两个页面均生成成功(各约 54 KB),导航中出现「SQL 入门手册」,正文渲染出 7 张表格、3 个代码块,构建日志没有本文件的告警mkdocs.yml把markdown_extensions写在theme:下,admonition扩展实际未启用,!!! note会原样输出。因此正文改用引用块(>)承载提示与警告,重建后确认页面中不再出现字面量!!!contribution/docs-format-guide.md):正文无多余一级标题、代码块均指定sql语言、表格与代码块前后留空行、中英文之间加空格、引用块内容有缩进01-quickstart.md、02-access.md均与本文同目录24-sql-primer.en.md未执行、需 reviewer 协助:
预览
导航位置:用户指南 → OpenTenBase → SQL 入门手册。
已知限制