【10/18-11/15】All Eyes on Docs! 练就火眼金睛，就来StarRocks 极客营

[Kate_Shao]

开放源代码运动的主要领导者——埃里克·雷蒙(Eric Steven Raymond)在他出版的《大教堂与集市》中描述了这样一个精彩的观点： 只要有足够多的眼球关注，就可让所有软件缺陷浮现 。他将之称为李纳斯定律 (Linus’s Law) 以此向李纳斯致敬。

文档作为软件的一部分在软件开发工作中占有突出的地位，高质量的文档对于充分发挥软件产品的效益有着重要的意义；对于开源社区来说，编写文档是开始参与开源项目的一个好方法。而且，无论你是初级还是大师级用户，你都可以带来观点，并修正错误。

因此，StarRocks 社区这次极客营推出了 All Eyes on Docs 文档活动，让大家可以用最小的成本加入社区，体会开源社区的魔力。这个活动除了希望借由社区小伙伴们的眼球，一起把文档里的 bugs 揪出来之外，你还可以为 StarRocks 的文档做出反馈，或是直接动手提交 PR，修改文档或是贡献新文档！

如何参加

1. 添加 StarRocks 小助手 （文末添加二维码）并回复“文档+ GitHub 用户名”完成报名

2. 在活动时间内对 StarRocks 中文文档提出有效 issue 或 PR （有效 issue 会打上 accepted 标签； 有效 PR 会标上 merged 或 approved 标签）

3. 11/15 活动结束前 提交问卷（见文末链接）并备注你的收件方式、 issue、PR 号等

活动时间

10/18-11/15

• 最新积分状况会于 每 1-2 周 公布在 StarRocks 社区论坛

• 11/22 公布积分最高的前三名

活动规则说明

• 活动范围：StarRocks 中文文档 （仅限 2.4 分支）

• 相同问题仅能选择提交 issue 或 PR 中一个，无需同时提交 issue 和 PR

• 同样的问题在不同文档出现，如果多次提交，只算一个问题

• 一次仅提交一个问题，请不要将多个问题放在一起提交

• 以下问题视为无效：

  • 问题无法定位

  • 问题非首次反馈 （如果不同 GitHub 用户都对同一问题提交了 issue 或 PR，只有最先提出问题的用户可以获得积分。大家在提交前可以到 issue list 或是 pull requests 页面检查一遍～）

  • 提供业务或产品建议而非针对文档的建议

• StarRocks 社区对本活动拥有最终解释权

如何提 issue， 举个

提交的 issue 应包含如下信息： 标题(Community+问题分级+问题概要） ， 文档路径（系统自动生成） ， 问题截图（建议提供） ， 详细的问题描述 ， 建议的解决方案（可选，建议提供） 。

说明：

• 每个 issue 或 PR 请在标题加上对应问题类型的标签 （内容合规类=P0，正确性问题 =P1，易用性问题=P2，规范和低错类=P3） ，以方便我们验证和统计您的积分

• 问题描述需要具体、详细。过于宽泛的描述比如“文档架构不合理”，属于无效问题

活动积分说明

	说明	提 issue	提 PR	其他
1	内容合规类	1-3	1-8
2	正确性问题	1-2	1-5
3	易用性问题	1-2	1-5
4	规范和低错类	1	1-2
5	新的文档或博客（整篇）		10-15
6	【加分项】为 StarRocks repo 点亮 Star

（需完成上述任一任务， 不能单独得分 ）|||1|

详细说明：

1. 内容合规类 （P0） ：

2. 违反法律法规等敏感词

3. 对重要数据或系统存在特别风险的操作，缺少安全提示

4. 内容侵权

5. 正确性问题 （P1）：

6. 技术原理、功能等描述和产品实现不一致，存在错误

7. 原理图、架构图等存在错误

8. 命令、参数等关键信息错误，命令无法完成对应功能

9. 步骤或界面错误，无法指导操作

10. 易用性问题 （P2)：

11. 文档架构不合理，内容缺乏逻辑性

12. 缺少必要的前提条件、或注意事项

13. 关键步骤缺失，无法指导用户完成任务

14. 描述存在歧义，晦涩难懂

15. 规范和低错类 (P3) ：

16. 错别字、拼写错误、标点符号错误

17. 链接错误、格式错误

18. 表述不通顺，有语病，但不影响理解

19. 界面和描述不一致，但不影响操作

20. 版本号不匹配：如软件包名称、界面版本号

奖品设置

3 分送：StarRocks 贴纸+电子感谢卡

5 分送：StarRocks 笔记本+贴纸+电子感谢卡

15 分送：StarRocks 马克杯+贴纸+电子感谢卡

20 分送：StarRocks 斜背包 or 卫衣+贴纸+电子感谢卡

25 分送：StarRocks 背包 or 斜背包+卫衣+贴纸+电子感谢卡

积分最高的前三名另外加送 极客营纯银纪念徽章一枚

领奖方式：填问卷并备注你的联系方式、 issue、PR 号等

加入交流群

添加 StarRocks 小助手 （文末添加二维码）并回复“文档+ GitHub 用户名”完成报名

1021 补充说明：

如果不知道怎么开始上手的话这里有几个小任务来让大家认领：

1. 中英文间添加空格 （最多可得 25 分）
   

   

2. 优化参考手册-SQL 参考

3. Primary Key 补充 Update 语法的文档

4. 除了文档外，也欢迎大家提交 blog、论坛帖（技术分享/教程类）、视频等，PR title 请用【Community-blog xxx】

–

相关链接

StarRocks GitHub

StarRocks 中文文档站

StarRocks 论坛积分帖

如何在官网和 GitHub 上为文档提交 issue 和 PR

Markdown 基本语法

文档活动信息收集问卷

[Kate_Shao]

如果不知道怎么开始上手的话这里有几个小任务来让大家认领：

1. 中英文间添加空格 （最多可得 25 分）

2. 优化参考手册-SQL 参考
3. Primary Key 补充 Update 语法的文档
4. 除了文档外，也欢迎大家提交 blog、论坛帖（技术分享/教程类）、视频等，PR title 请用【Community-blog xxx】

[Kate_Shao]

截止到 10/28 的积分排名前五名：

恭喜这些小伙伴！ 其他小伙伴继续努力，活动将持续到 11/15 ，我们还有机会 ！！

[Kate_Shao]

接着公布所有参与人员的积分 （统计至 10/28）

GitHub ID	Issue	PR	Total
amber-create		5	5
buggithubs		8	8
chen9t		26	26
choury		5	5
evelynzhaojie		12	12
femiiii		10	10
gaoy121		28	28
hellolilyliuyi		10	10
Johnsonginati		2	2
lixiaoer666		60	60
mklzl		4	4
Pslydhh		5	5
Seaven		20	20
TTTTzz		4	4
wanghuan2054		22	22
wangruin		5	5
yinmh		12	12
herocc19	11		11
huangfeng1993	2		2
lvchenyang-maker	8		8
WuMenglong	27	73	100
Zhangruichao	2		2
郑荣			0

如果对积分有问题的小伙伴可以在提交的 issue 或 PR 里提问，或是在这里留言找我～ 感谢大家参与！11/15 活动才结束，大家继续冲鸭！

[Kate_Shao]

公布最新战况如下
活动还有 天结束，大家冲鸭！

GitHub ID	Issue	PR	Total	Ranking
amber-create	0	5	5
buggithubs	0	17	17
chen9t	0	26	26
choury	0	5	5
evelynzhaojie	4	12	16
femiiii	0	10	10
gaoy121	4	30	34	5
hellolilyliuyi	0	10	10
Johnsonginati	0	2	2
lixiaoer666	0	60	60	4
mklzl	0	4	4
Pslydhh	0	5	5
Seaven	0	22	22
TTTTzz	0	4	4
wanghuan2054	2	88	90	3
wangruin	0	5	5
yinmh	0	12	12
herocc19	44	98	142	1
huangfeng1993	4	0	4
lvchenyang-maker	8	0	8
WuMenglong	28	107	135	2
Zhangruichao	3	0	3
郑荣	2	0	2
joyceapp	4	0	4
blanklin030	0	5	5
chenyjsr	0	14	14
huangyanyanyan	0	2	2
lizhipeng1	0	2	2
rickif	0	2	2
Shan-01	0	23	23
silverbullet233	0	5	5
syyfffy	0	9	9
zhang199611	0	5	5

[Kate_Shao]

截止到 11/10 的积分排名前五名：

[Kate_Shao]

文档活动的最终积分如下：
大家快来找我换礼物吧～

GitHub ID	Issue	PR	Total	Ranking
amber-create		5	6
buggithubs		17	18
chen9t		26	26
choury		5	5
evelynzhaojie	6	12	19
femiiii		10	11
gaoy121	9	30	40	5
hellolilyliuyi		10	11
Johnsonginati		2	3
lixiaoer666		60	60	4
mklzl		4	5
Pslydhh		5	6
Seaven		22	23
TTTTzz		4	5
wanghuan2054	4	80	85	3
wangruin		5	6
yinmh		12	13
herocc19	81	241	323	1
huangfeng1993	6		7
lvchenyang-maker	8		9
WuMenglong	68	228	297	2
Zhangruichao	4		5
郑荣	2		2
joyceapp	8		9
blanklin030		5	6
chenyjsr		14	15
huangyanyanyan		2	3
lizhipeng1		2	2
rickif		2	3
Shan-01		25	26
silverbullet233		5	5
syyfffy		9	9
zhang199611		5	6
murphy	2		3
531651225		15	15

• 点了 star 总分自动加一分

[Kate_Shao]

恭喜最终排名前 5 名的同学！