文档提升计划第三期|OceanBase 邀您一起进行文档共建

很多同学会认为参与开源社区是技术大牛的事情,其实不然,任何人都可以参与开源项目进行贡献。只要你的提交可以提升项目质量,哪怕是一个错别字的修改都会得到肯定。

OceanBase 之前举办的两期文档提升计划,得到了社区用户的广泛支持。这不 2022 数据库大赛在即,OceanBase 社区针对提升数据库内核开发能力的教程「从0到1数据库内核实战」也已经上线,为了更好地为大家提供知识沉淀,该教程将被编撰为电子本。现在诚邀活跃用户与技术专家共建电子书内容。社区的建设一直离不开你的支持,当你在平时浏览社区时遇到任何问题欢迎随时提报,我们将第一时间进行跟进。

面向人群: 开发者、学生、DBA、数据库爱好者…只要你想参加,OceanBase 都欢迎!!!

 

参与文档共建你将获得什么?

福利部分:电子书署名&OceanBase周边礼物&月度之星提名(说明:如遇到类似/相同 Pr, 先提交者获得周边礼物)

技能提升:系统进阶内核开发,与数据库专家0距离交流技术难题
 

活动详情

活动时间:9月19日—12月16日

第一阶段:进入电子书共建

时间:9月9日-10月17日

选择你感兴趣的电子书章节,根据自己所负责的章节进行内容共建。可以扫描下方二维码进入「文档贡献交流群」找到志同道合的小伙伴!

选择好自己感兴趣的章节后,就可以开始“找茬”啦~“找茬”包含但不限于以下四种类型:
 

类型1:不规范和低错类

例如:

• 错别字

• 标点使用错误

• 文档格式错乱

 

类型2:内容结构不合理、语言表达不清晰

例如:

• 有依赖关系的内容,前后顺序错乱

• 语句歧义、不明确,如存在“大概、可能、也许、十分、稍微”等词语

 

类型3:内容错误

例如:

• 概念、定义、参数介绍等信息错误

• 操作步骤错误,无法按文档完成任务
 

类型4 :内容缺失

例如:

• 操作步骤缺失,无法按文档完成任务

• 产品支持的功能在文档中没有体现

GitHub 提交方式

1)进入官网文档页面,找到你要修改的文档,点击文档右上方的编辑 ,进入 Github

2)在弹出的页面,登陆/注册你的 GitHub 账号。

3)单击 Fork this repository ,将直接进入 md 文件编辑页面。

4)完成修改后,单击 Propose changes ,保存你的修改。

5)单击 Creat pull request ,提交 Pr。

第二阶段:输出实战文章

时间:10月18日-12月16日

在完成第一阶段「电子书共建」后,下面你也可以自己输出实战文章,类型不限与操作教程、自我感受、撰写 OceanBase 源码解读文章…只要你有要分享的内容,OceanBase 统统欢迎,赶快来参加吧!

社区的成长离不开开放和共享,更离不开每一位社区用户的建议和贡献,欢迎每一位社区用户的加入,一起创造更好的阅读体验,建设更好的文档吧!

2 个赞

:face_with_peeking_eye:又到了检验 OB 知识学习成果的时候啦,大家一起来提升文档吧

3 个赞

马老师加油~ :smile:

1 个赞

马老师加油~ :smile:

1 个赞

:rofl:大家加油,发现问题提升学习~~