TiDB 文档挑战赛 ｜ 2024 年 1 月 9 日 - 12 日 ｜ 参与说明

[qiancai]

🚀 欢迎参加 2024 TiDB 文档挑战赛 (TiDB Docs Dash)！

为了给大家带来更好的文档使用体验，首届 TiDB 文档挑战赛 (TiDB Docs Dash) 将于 2024 年 1 月 9 日 - 12 日进行。同时，我们也希望将借此机会将 TiDB 社区成员聚集到一起，为大家带来一次有趣的协作体验。

在这为期三天的活动中，你将有机会与社区其他成员合作，共同改进 TiDB 文档 和 TiDB Cloud 文档。

🗓️ 活动时间

在此次活动中，我们为大家准备了各种类型的文档小任务，包含 “调试” 文档、完善文档、翻译文档、解决文档问题等。

• 任务认领时间：即日起 — 1 月 12 日 16:00
• 任务提交时间：2024 年 1 月 9 日 16:00 至 2024 年 1 月 12 日 16:00 (北京时间）

参与方式

你可以在我们的 2024 TiDB 文档挑战赛 - 任务列表 中查看所有可以领取的任务，并挑选你感兴趣的任务类型：

• Debug Documentation（调试文档）：

  • 测试和验证 TiDB 或 TiDB Cloud 文档，确保其准确性和有效性。
  • 你可以在以下 issue 中找到待验证的文档列表：
    • 中文文档：Debug TiDB Documentation: TiDB 中文文档测试说明 #15772
    • 英文文档：Debug TiDB Cloud Documentation: Summary Issue docs#15480

• Translate Documentation （翻译文档）：

  • 将文档 Pull Requests 从中文翻译为英文，或从英文翻译为中文。
    • 需要中翻英的 Pull Requests：https://github.com/orgs/pingcap/projects/51/views/5
    • 需要英翻中的 Pull Requests：https://github.com/orgs/pingcap/projects/51/views/6
  • 关于翻译任务的详细信息，请查看 #15132。

• Enrich Documentation （完善文档）：

  • 在现有文档中添加说明和示例，完善内容，使其对用户更友好。
  • 你可以在以下 issue 中找到需要完善的文档。TiDB 提供了中英文双语文档，你可以选择在中文文档仓库提 PR 完善中文文档、在英文文档仓库提 PR 完善英文文档、或者同时在这两个仓库提 PR 完善双语文档。
    • Enrich Documentation: 完善 TiDB 字符串函数中文文档说明 #15947
    • Enrich Documentation: TiDB String Functions  docs#15417
    • Enrich Documentation: Type Conversion in Expression Evaluation docs#15444
    • Enrich Documentation: ADMIN CHECKSUM TABLE docs#15468

• Resolve Existing Doc issues（解决现有文档问题）：

  • 为现有的文档 issue 提供解决建议，或者通过创建 PR 解决现有文档问题。
  • 你可以在 https://github.com/orgs/pingcap/projects/51/views/3 中所有此类型的 issue。

• Improve Documentation CI/HTML/PD （改进文档 CI/HTML/PDF）

  • 编写代码，优化 TiDB 文档的 CI 检查、HTML 网页、PDF 输出。
  • 你可以在 https://github.com/orgs/pingcap/projects/51/views/3 中所有此类型的 issue。

选择好感兴趣的任务后，你可以在任务对应的 issue 或 PR 的 comment 中添加 /assign 命令将此任务分配给自己。

如果一个 issue 或 PR 已经有 assignee，说明该任务已经有人认领，请重新选择其他的任务。

除了本次活动中列出的任务外，我们也非常欢迎你通过创建 issue 指出你发现的其他文档问题或创建 PR 来直接修复你发现的问题。

活动奖品

• 活动定制徽章：

  • 每位参与者将获得一枚定制电子徽章，你可以将它添加到你的 GitHub 个人主页 README 中彰显你为开源文档做出的贡献。

• Top 1-5 名贡献者奖品：

  • 贡献计分最高的前五名贡献者将额外获得精美的奖品。

PR 快速上手指南

1. Fork 文档仓库：

   点击仓库右上角的 Fork 按钮，等待 Fork 完成即可。

   • TiDB 中文文档仓库：https://github.com/pingcap/docs-cn
   • TiDB 和 TiDB Cloud 英文文档仓库：https://github.com/pingcap/docs

2. Clone 文档仓库，创建文档 PR：

   • 参考任务列表中各 issue 的说明，提交 PR 或在 issue 上提供建议。

   • 参考 TiDB 文档贡献指南 创建文档 PR。

     注意：目前，TiDB Cloud 文档 仅提供英文版本，其源文件存储在 pingcap/docs 仓库的的 release-7.5 分支中，目的是为了实现对 TiDB 相关文档的内容重用。因此，当你需要创建 PR 更新 TiDB Cloud 文档时，请确保你的 PR 基于 release-7.5 分支。

   • 在 PR 描述中，请注明此 PR 所相关的 issue。

3. 关注并提交 PR 的修改建议：

   • 创建 PR 后，我们会查看 PR 内容，并对需要修改的地方添加修改建议。
   • 你可以接受建议并进行更改，或拒绝建议并在建议下方回复你的理由。

活动详情

• 关于此活动的更多信息，请参考 2024 TiDB 文档挑战赛活动介绍页面。
• 如有任何疑问或需要帮助，欢迎在此 issue 上添加评论。

[tianshaochun01]

like it