首届 TiDB 文档挑战赛 3圆满收官啦!
在这短短的三天时间里,我们一共收到了来自社区成员的 97 个 pull requests、7 个 new issues,且有 89 个 issue 被关注和推进。截止目前,超过 90 个 pull requests 已经合并。
通过大家的共同努力,我们高效完成了以下挑战任务,极大地提升了 TiDB 和 TiDB Cloud 文档 1的准确性、完整性、可用性:
- 测试了 33 篇高频访问文档并就其中的问题进行了改进
- 完善了 22 个字符串函数的文档,提供了丰富的使用示例
- 翻译了 36 个文档 PR,提高了中英双语文档的一致性
- 解决了 8 个已知的文档问题以及 11 个新发现的文档问题
比起这些数字,参与这场活动的 TiDBer 们对文档改善的用心更让我们印象深刻。好多小伙伴都是边实操、边验证,并给出了非常多有深度、很细节、很实用、很用心的建议和 pull requests,比如:来自 Minae Lee 5 的用心建议、来自 Shawn Yan 4 对两篇应用开发文档的很棒的翻译、来自 Chrissy Belzie 2 关于优化文档网站用户体验的建议、来自 curiuosRay 对 PDF 格式文档中表格宽度显示问题的修复(TiDBer 真的都是宝藏!),我们将采纳优质建议,努力提升文档质量💪,感恩❤️ !!
这也是首场全球联动的文档挑战赛,我们也非常高兴看到来自日本、美国、新加坡、尼日利亚等国家和地区的贡献者们参与到本次活动中,为文档质量的提升贡献了自己的力量!
TiDB Docs Dash 2024 前五名名单公布!
在此也恭喜中文社区的获奖者!社区之光!! @ShawnYan @讷言敏行 @hey-hoho @RobertCheng @llkdd1
奖项 | Github ID | PR 和 issue 贡献说明 |
---|---|---|
shawn0915 4 | 提交 22 个 PR 和 5 个 issue | |
enkilee 5 | 提交 15 个 PR | |
hey-hoho 2 | 提交 10 个 PR | |
RobertCheng 5 和 llkdd1 3 | 这两位贡献者均提交了 7 个 PR | |
minaelee 5 | 提交了 3 个 PR 和许多很棒的文档建议 |
Top 5 奖品:
第一名 Bose 蓝牙降噪耳机
第二名 500 元京东礼品卡
第三名 TiDB 定制机械键盘
第四名 TiDB 定制周边礼包
第五名 TiDB 定制周边礼包
临近春节,活动奖励将在 2 月 26 号之后发放喔,感谢你的等待和支持!
请获奖的 TiDBer 私聊 TiDB Robot 微信(tidbai)发送邮寄信息🧡
贡献列表:
谢谢所有参赛者贡献的每一个 issue 和 PR!
所有参与者的 Github ID + 贡献 说明
GitHub ID | 贡献说明 |
---|---|
CBID2 2 | 提交 1 个 PR 修复文档站图片 alt text 问题,并测试了 1 篇文档 |
cool-wangtongzhou | 测试了 1 篇文档 |
CrystalAnalyst 1 | 提交了 1 个 文档翻译 PR |
curiousRay | 提交了 2 个 代码 PR (解决了文档站 PDF 表格宽度显示问题,并提供了文档站图片缩放功能支持的方案之一) |
dveeden | 提交了 1 个 PR (将 TRUNCATE 语法图从 PNG 转成了 EBNF diagram) |
enkilee 5 | 提交了 15 个文档 PR (包括 13 个文档翻译 PR 和 2 个解决测试文档时发现问题的 PR) |
hecao100 | 提交了 1 个 PR (改进安全文档描述) |
hey-hoho 2 | 提交了 10 个 PR(解决了 4 个已知文档问题,测试了 4 篇文档并就发现的问题进行了文档内容改进) |
heywalter 2 | 提交了 2 个 PR (完善 4 个字符串函数的文档) |
hzc989 | 提交了 2 个 PR (解决 1 个已知文档问题,PR 仍在 review 中) |
ittuann | 提交了 2 个 PR (完善了 4 个字符串函数的中英双语文档) |
JaySon-Huang | 提交了 4 个 PR (新发现并解决了 TiKV 和 TiFlash 的 2 个文档问题) |
Jellybeanvino | 测试了 2 篇文档并就发现的问题提了 2 个 PR |
jiajunc516 | 提交了 1 个 PR (新发现并解决了 1 个文档问题) |
jyf111 1 | 测试了 1 篇文档并就发现的问题提了 1 个 PR;提交了 1 个 PR (完善 2 个字符串函数的文档,PR 仍在 review 中) |
kenudeh | 测试了 2 篇文档并就发现的问题提了 2 个 PR |
llkdd1 3 | 提交了 7 个 文档翻译 PR |
lyssom | 提交了 1 个 PR(完善 2 个字符串函数的文档) |
minaelee 5 | 测试了 5 篇应用开发文档,提出了许多有价值的建议,并提了 3 个 PR 修复发现的问题 |
PitifulPete | 提交了 2 个 PR (完善 4 个字符串函数的文档) |
PokIsemaine | 测试了 1 篇文档 |
pushmeintheair | 提交了 1 个 PR (新发现并解决了 1 个文档问题) |
RakerZh | 测试了 2 篇文档并就发现的问题提了 2 个 PR |
RobertCheng-956 5 | 提交了 7 个 文档翻译 PR |
sgykfjsm | 测试了 1 篇文档并就发现的问题提了 1 个 PR |
shawn0915 4 | 提交了 22 个 PR 和 5 个 issue (测试了 4 篇文档并就发现的问题分别提了 PR,解决了 2 个已知的文档问题,翻译了 3 篇长篇文档,新发现并解决了 10 个文档问题,主动参与其他贡献者 PR 的 review) |
takaidohigasi 1 | 提交了 1 个 PR (完善 2 个字符串函数的文档) |
Takashi-kun | 提交了 2 个 PR (完善 4 个字符串函数的文档) |
TinaZhuzhu | 提交了 1 个文档翻译 PR |
WalterWj | 提交了 1 个 PR (完善 TiUP 文档) |
Weaxs | 测试了 5 篇文档并就发现的问题提了 2 个 PR,提交了 2 个 PR 完善 1 个字符串函数的中英双语文档 |
yusra1007 | 提交了 3 个文档翻译 PR |
longlongago7777 | 提交了 1 个 issue |
- 完整的 issue 认领详情和各 issue 的状态,请参考 https://github.com/orgs/pingcap/projects/51/views/9。 3
- 完整的 PR 贡献详情和各 PR 的状态,请参考 https://github.com/orgs/pingcap/projects/51/views/13。 5
感谢以上所有的文档贡献者!
参与贡献的社区小伙伴的 Contributor 徽章和已合并的 PR 积分奖励已授予哦!(如有遗漏请私信 TiDB Robot 微信:tidbai)
ps. 已合并的 PR 列表:https://github.com/orgs/pingcap/projects/51/views/15 1 (还在 Review 中的 PR 一旦被合并,将第一时间授予社区积分奖励哈 )
@curiousRay @讷言敏行 @hey-hoho @heywalter @hzc989 @JaySon-Huang @Jellybean @TiDBer_uxzEmawk @鱼竿钓鱼干 @RobertCheng @ShawnYan @WalterWj @魔人逗逗
20240204-1842132236×1380 203 KB
亮点贡献:
在所有贡献中,我们也有一些亮点贡献想分享给大家!
- Chrissy Belzie 不仅发现了我们文档站图片的 alt text 可读性的问题,而且还提交了一个 PR,以便使用屏幕阅读器的人能更好地了解页面内容。(更多详情可以查看:https://github.com/pingcap/website-docs/issues/463)
- Shawn Yan 提交的两篇应用开发中文翻译文档用词精准、文笔流畅,而且他在翻译过程发现并修复了原来英文中的 3 处错误。(更多详情可以查看:https://github.com/pingcap/docs-cn/pull/16165 3 和https://github.com/pingcap/docs/pull/16134) 1
- curiuosRay的 2 个 PR 将有助于改进我们文档网站和 PDF。(更多详情可以查看:(https://github.com/pingcap/website-docs/pull/464,https://github.com/pingcap/docs-cn/pull/16173) 1
如何在你的 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 文档挑战赛徽章中的详细步骤。
参与活动抽奖结果公布!
恭喜 @curiousRay !请私聊 TiDB Robot 微信(tidbai)发送邮寄信息及选择的背包款式(二选一)哈~
感谢以下 TiDBer 参与首届 TiDB 文档挑战赛评论区互动!
@ShawnYan @WalterWj @RobertCheng @小龙虾爱大龙虾 @春风十里 @hey-hoho @裤衩儿飞上天 @xiongjiwei @forever @dba-kit @MrSylar @讷言敏行 @魔人逗逗 @okenJiang @Jellybean @xfworld @Aionn @OMGZEXAL @像风一样的男子 @半瓶醋仙 @Skwo @LI-ldc @curiousRay @Cong-PingCAP @随缘天空 @来了老弟 @TiDB_C罗 @Kongdom @xpume @Zehao @TiDBer_pFFcXLgY @heywalter @mono @鱼竿钓鱼干 @JaySon-Huang @TiDBer_uxzEmawk @普罗米修斯 @hzc989
附:TiDB 文档链接
- TiDB 中文文档:https://github.com/pingcap/docs-cn 1
- 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)