活动回顾 & 奖项公布丨首届全球 TiDB 文档挑战赛圆满收官！来看看前五名花落谁家！

PingCAP 2024-02-19

215

首届 TiDB 文档挑战赛圆满收官啦！

在这短短的三天时间里，我们一共收到了来自社区成员的 97 个 pull requests、 7 个 new issues，且有 89 个 issues 被关注和推进。截止目前，超过 90 个 pull requests 已经合并。

通过大家的共同努力，我们高效完成了以下挑战任务，极大地提升了 TiDB ( https://docs.pingcap.com/zh/tidb/stable )和 TiDB Cloud 文档( https://docs.pingcap.com/tidbcloud/ )的准确性、完整性、可用性：

● 测试了 33 篇高频访问文档并就其中的问题进行了改进

● 完善了 22 个字符串函数的文档，提供了丰富的使用示例

● 翻译了 36 个文档 PR，提高了中英双语文档的一致性

● 解决了 8 个已知的文档问题以及 11 个新发现的文档问题

比起这些数字，参与这场活动的 TiDBer 们对文档改善的用心更让我们印象深刻。好多小伙伴都是边实操、边验证，并给出了非常多有深度、很细节、很实用、很用心的建议和 pull requests，比如：来自 Minae Lee 的用心建议、来自 Shawn Yan 对两篇应用开发文档的很棒的翻译、来自 Chrissy Belzie 关于优化文档网站用户体验的建议、来自 curiuosRay 对 PDF 格式文档中表格宽度显示问题的修复（TiDBer 真的都是宝藏！），我们将采纳优质建议，努力提升文档质量💪，感恩❤️ ！！

这也是首场全球联动的文档挑战赛，我们也非常高兴看到来自日本、美国、新加坡、尼日利亚等国家和地区的贡献者们参与到本次活动中，为文档质量的提升贡献了自己的力量！

TiDB Docs Dash 2024 前五名名单公布

在此也恭喜中文社区的获奖者！社区之光！！

@ShawnYan @讷言敏行 @hey-hoho @RobertCheng @llkdd1

Top 5 奖品：

第一名 Bose 蓝牙降噪耳机

第二名 500 元京东礼品卡

第三名 TiDB 定制机械键盘

第四名 TiDB 定制周边礼包

第五名 TiDB 定制周边礼包

临近春节，活动奖励将在 2 月 26 号之后发放喔，感谢你的等待和支持！

请获奖的 TiDBer 私聊 TiDB Robot 微信（tidbai）发送邮寄信息🧡

贡献列表

谢谢你们贡献的每一个 issue 和 PR！

所有参与者的 Github ID + 贡献 说明

◉ 完整的 issue 认领详情和各 issue 的状态，请参考https://github.com/orgs/pingcap/projects/51/views/9

◉ 完整的 PR 贡献详情和各 PR 的状态，请参考 https://github.com/orgs/pingcap/projects/51/views/13

💕感谢以上所有的文档贡献者！

参与贡献的社区小伙伴的 Contributor 徽章和已合并的 PR 积分奖励已授予哦！（如有遗漏请私信 TiDB Robot 微信：tidbai）

ps. 已合并的 PR 列表：https://github.com/orgs/pingcap/projects/51/views/15 （还在 Review 中的 PR 一旦被合并，将第一时间授予社区积分奖励哈）

@curiousRay @讷言敏行 @hey-hoho @heywalter @hzc989 @JaySon-Huang @Jellybean @TiDBer_uxzEmawk @鱼竿钓鱼干 @RobertCheng @ShawnYan @WalterWj @魔人逗逗

亮点贡献

谢谢你们贡献的每一个 issue 和 PR！

在所有贡献中，我们也有一些亮点贡献想分享给大家！

● Chrissy Belzie 不仅发现了我们文档站图片的 alt text 可读性的问题，而且还提交了一个 PR，以便使用屏幕阅读器的人能更好地了解页面内容。（更多详情可以查看：https://github.com/pingcap/website-docs/issues/463）

● Shawn Yan 提交的两篇应用开发中文翻译文档用词精准、文笔流畅，而且他在翻译过程发现并修复了原来英文中的 3 处错误。（更多详情可以查看：https://github.com/pingcap/docs-cn/pull/16165 和 https://github.com/pingcap/docs/pull/16134）

●  curiuosRay 的 2 个 PR 将有助于改进我们文档网站和 PDF。（更多详情可以查看：https://github.com/pingcap/website-docs/pull/464，https://github.com/pingcap/docs-cn/pull/1617）

如何在你的 GitHub 主页添加电子徽章

如果你已经创建过你的 GitHub 主页 README，可以直接在 README 文件中添加以下代码，并将 {{github_username}} 替换为你的 GitHub 用户名。提交更改后，刷新你的 GitHub 主页，即可看到 TiDB 文档挑战赛徽章。

<p>
  <img src="https://api.vaunt.dev/v1/github/entities/{{github_username}}/achievements?format=svg&limit=3" width="350" />
</p>

如果你没有配置过 GitHub 个人主页 README，请参考如何在你的 GitHub 个人资料页上添加 TiDB 文档挑战赛徽章 ( https://github.com/pingcap/docs-cn/blob/master/.vaunt/add-tidb-docs-dash-badge.md )中的详细步骤。

附：TiDB 文档链接

◉ TiDB 中文文档：https://github.com/pingcap/docs-cn

◉ TiDB 英文文档：https://github.com/pingcap/docs

◉ TiDB Cloud 英文文档：https://github.com/pingcap/docs/tree/release-7.5

◉ TiDB 文档网站代码：https://github.com/pingcap/website-docs

◉ TiDB 中文文档贡献指南：https://github.com/pingcap/docs-cn/blob/master/CONTRIBUTING.md

◉ TiDB 英文文档贡献指南：https://github.com/pingcap/docs/blob/master/CONTRIBUTING.md

💡 点击文末【阅读原文】，立即下载试用 TiDB！