申请试用
HOT
登录
注册
 

All Eyes on Docs! 练就火眼金睛,就来 StarRocks 极客营

StarRocks
/
发布于
/
219
人浏览
训练技术品味的绝好机会,还有诸多精美奖品。

​​开放源代码运动的主要领导者——埃里克·雷蒙(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

StarRocks 中文文档站

https://docs.starrocks.io/zh-cn/2.4/introduction/StarRocks_intro

StarRocks 论坛积分帖

https://forum.starrocks.com/t/topic/3473

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

https://github.com/StarRocks/docs.zh-cn

Markdown 基本语法

https://markdown.com.cn/basic-syntax/

文档活动信息收集问卷

https://jinshuju.net/f/yobT7V


关于 StarRocks 

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

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

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

分享
1 点赞
0 收藏
确认
3秒后跳转登录页面
去登陆