关于数据库:All-Eyes-on-Docs-练就火眼金睛就来-StarRocks-极客营

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

文档作为软件的一部分，在软件开发工作中占有突出位置，高质量的文档对于充分发挥软件产品的效益意义重大。对于开源社区来说，编写文档是开始参加开源我的项目的一个好办法。而且，无论你是高级还是大师级用户，都能够带来观点，并修改谬误。

因而，StarRocks 极客营这次推出了 All Eyes on Docs 文档流动，让大家能够用最小的老本退出社区，领会开源社区的魔力。除了用你的火眼金睛一起揪出文档 bug 之外，你还能够为 StarRocks 的文档做出反馈，或是间接入手提交 PR，批改文档或是奉献新文档！

1、如何加入

1. 增加 StarRocks 小助手（文末增加二维码）并回复“文档 + GitHub 用户名”实现报名
2. 在流动工夫内对 StarRocks 中文文档提出无效 issue 或 PR（无效 issue 会打上 accepted 标签；无效 PR 会标上 merged 或 approved 标签）
3. 11/15 流动完结前提交问卷（见文末链接）并备注你的收件形式、issue、PR 号等

2、流动工夫

10/18-11/15 

• 最新积分情况会于每 1-2 周颁布在 StarRocks 社区论坛 
• 11/22 颁布积分最高的前三名

3、流动规定阐明

• 流动范畴：StarRocks 中文文档（仅限 2.4 分支）
• 雷同问题仅能抉择提交 issue 或 PR 中一个，无需同时提交 issue 和 PR
• 同样的问题在不同文档呈现，如果屡次提交，只算一个问题
• 一次仅提交一个问题，请不要将多个问题放在一起提交
• 以下问题视为有效：

问题无奈定位

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

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

• StarRocks 社区对本流动领有最终解释权

4、如何提 issue

提交的 issue 应蕴含如下信息：题目(Community+ 问题分级 + 问题概要），文档门路（零碎主动生成），问题截图（倡议提供），具体的问题形容，倡议的解决方案（可选，倡议提供）。

​

阐明：

• 每个 issue 或 PR 请在题目加上对应问题类型的标签（内容合规类 =P0，正确性问题 =P1，易用性问题 =P2，标准和低错类 =P3），以不便咱们验证和统计您的积分
• 问题形容须要具体、具体。过于宽泛的形容比方“文档架构不合理”，属于有效问题

5、流动积分阐明

具体阐明：

1. 内容合规类（P0）：

• 违反法律法规等敏感词
• 对重要数据或零碎存在特地危险的操作，短少平安提醒
• 内容侵权

2. 正确性问题（P1）：

• 技术原理、性能等形容和产品实现不统一，存在谬误
• 原理图、架构图等存在谬误
• 命令、参数等要害信息谬误，命令无奈实现对应性能
• 步骤或界面谬误，无奈领导操作

3. 易用性问题（P2)：

• 文档架构不合理，内容不足逻辑性
• 短少必要的前提条件、或注意事项
• 关键步骤缺失，无奈领导用户实现工作
• 形容存在歧义，艰涩难懂

4. 标准和低错类 (P3)：

• 错别字、拼写错误、标点符号谬误
• 链接谬误、格局谬误
• 表述不通顺，有语病，但不影响了解
• 界面和形容不统一，但不影响操作
• 版本号不匹配：如软件包名称、界面版本号

6、奖品设置

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

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

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

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

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

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

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

​

7、退出交换群

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

8、相干链接

StarRocks GitHub

https://github.com/StarRocks/…

StarRocks 中文文档站

https://docs.starrocks.io/zh-…

StarRocks 论坛积分帖

https://forum.starrocks.com/t…

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

https://github.com/StarRocks/…

Markdown 根本语法

https://markdown.com.cn/basic…

文档流动信息收集问卷

https://jinshuju.net/f/yobT7V

对于 StarRocks

面世两年多来，StarRocks 始终专一打造世界顶级的新一代极速全场景 MPP 数据库，帮忙企业建设“极速对立”的数据分析新范式，助力企业全面数字化经营。

以后曾经帮忙腾讯、携程、顺丰、Airbnb、滴滴、京东、众安保险等超过 170 家大型用户构建了全新的数据分析能力，生产环境中稳固运行的 StarRocks 服务器数目达数千台。

2021 年 9 月，StarRocks 源代码凋谢，在 GitHub 上的星数已超过 3400 个。StarRocks 的寰球社区飞速成长，至今已有超百位贡献者，社群用户冲破 7000 人，吸引几十家国内外行业头部企业参加共建。

​