1. 如何找到一篇 TiDB 文档的源文件存储在 GitHub 哪里?
以 v7.5 TiDB 简介 文档为例,滚动鼠标至文档页面底部,点击该文档的 GitHub 链接,直达 docs-cn/overview.md at release-7.5 · pingcap/docs-cn · GitHub
2. 认领了中英文翻译任务后,我需要做什么?
Tips:
- TiDB 的中英文文档分别存放于 pingcap/docs-cn 和 pingcap/docs 仓库中,并且两个仓库的文件结构完全对应。
- 如果从未创建过 PR,可以提前参考 lilin90 撰写的小白上手流程快速掌握提 PR 步骤。想要通过视频学习的伙伴们,可以直接观看我们的 GitHub 新手指南短视频教程。
- 当认领了中文仓库 pingcap/docs-cn 的一个待翻译 PR 后,你需要在英文仓库 pingcap/docs 建一个对应的英文 PR。
- 当认领了英文仓库 pingcap/docs 的一个待翻译 PR 后,你需要在中文仓库 pingcap/docs-cn 建一个对应的中文 PR。
以中文到英文的翻译任务为例:
- Fork 英文文档仓库 pingcap/docs,并将 fork 的仓库克隆到本地。
- 找到中文 PR 改动涉及的同名的英文文件,按照中文 PR 中的改动,对应修改英文文件,添加翻译。
翻译时,请参考 TiDB 中英术语表。 - 英文修改完毕后,在英文文档仓库 pingcap/docs 创建新 PR,提交翻译好的文件。
创建 PR 时,请按照 PR 模板填写 PR 描述。 例如,在 PR 描述中的 This PR is translated from 后添加中文 PR 的链接。 - 处理翻译 PR 的翻译状态标签:
-
英文 PR 创建好后,请在 PR 的 comment 中添加
/translation from-docs-cn
命令(该命令可以为 PR 添加 translation/from-docs-cn label),表明此 PR 是从中文翻译过来的。
如果是英文到中文的翻译任务,需添加/translation from-docs
命令。 -
回到中文 PR ,在中文 PR 的 comment 中添加
/remove-translation doing
和/translation done
命令,将 PR label 修改为 translation/done,表明翻译已完成。
3. 某一类型的任务被认领完后,还会添加新任务吗?
-
根据任务的认领情况,我们会在 1 月 12 日前增加一些新任务,请持续关注 2024 TiDB Docs Dash Issue List | 2024 TiDB 文档挑战赛任务列表 · GitHub 查看未认领的任务。
-
最新任务:2023 年 12 月 29 日,我们新增了 6 个关于完善 TiDB 字符串函数中文文档说明的任务,欢迎大家来认领。
4. 提交了文档 PR 之后,我应该做什么?
-
耐心等待评审:由于活动任务量和参与者规模,你的 PR 可能不会立刻得到评审或合并,请耐心等待。
-
关注 PR 评论、接受/拒绝评审建议:注意查看并回应 PR 的评论。如果你同意 reviewer 的建议,请按照建议修改文档。如果你不同意某个建议,请在评论中说明理由。 小贴士:批量接受 review 建议和处理 CI 检查
-
注意截止日期:只有在 2024 年 1 月 26 日前被合并的 PR,才能计入活动积分赢取精美礼品。
欢迎 TiDBer 随时提出你们的疑问,本帖子将持续更新~