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

项目地址:https://gitee.com/organizations/oceanbase/projects


你想快速学习更多知识吗?

你享受分享的快乐吗?

如果你的回答是 Yes

那么一起参与第二期文档提升计划吧!

6月1日,我们再度起航,欢迎热爱挑战、乐于分享的你一起开启文档共建旅程!


活动流程

活动时间:6月1日-6月30日

文档评审时间:7月1日-7月8日

结果公布+社区荣誉&激励:7月11日-7月15日


活动适用人群

提升学习效率,快速学习分布式数据库知识的学生

掌握 OceanBase 使用技能,想快速实现从入门到精通的 DBA

了解 OceanBase 功能模块及原理,从事数据库功能开发的人员

提升技术实力,考取 OBCP 认证的数据库从业者


活动收获

积累知识力量,形成个人成长体系

参与开源项目共建,结识志同道合的朋友

帮助社区新手用户更快上手 OceanBase

你提的建议一旦被采纳,你将成为社区贡献者,登上社区荣誉榜

同时,我们也准备了OBCP 考试券、露营帐篷、 颈椎枕头以及一些 OceanBase 周边及专属纪念品表示感谢。


参与方式

01 包含哪些任务类型?


主要包括以下四个类型,我们推荐你可以按照以下方式进行:


类型1:不规范和低错类

例如:

• 错别字

• 标点使用错误

• 文档格式错乱


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

例如:

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

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


类型3:内容错误

例如:

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

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


类型4 :内容缺失

例如:

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

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

您可以在文档中心选择希望参与贡献的方向,查找相应的问题类型并提交 PR,参与文档提升计划

如果您是第一次接触社区版的用户,建议先从产品文档入手


02 如何开始贡献?


6月1日-6月30日,通过 OceanBase 开源官网反馈文档问题,即为参与社区文档提升计划。赶紧加入吧!提升技能,为社区做贡献,还有更多惊喜等你来拿!


03 如何参与贡献?


1、加入钉钉群

想要参加活动的朋友们,墙裂建议加入我们唯一官网钉钉群:41203246,届时我们将在群里互动答疑,为您解决活动中遇到的各种问题🎉

钉钉群号: 41203246


2、活动前准备

你需要拥有一个 gitee 账号。


3、活动中操作步骤

步骤:

  1. 登录到 Gitee 的 OceanBase 项目,https://gitee.com/oceanbase
  2. 找到想要提交问题的文档。Gitee 中 OceanBase 各个产品对应的文档仓库和地址如下。




3.克隆本地分支。

4.修改内容并保存。

5.提交并生成 PR。

至此,您就成功的捉到了一个🐛(提交了一个PR)~

后续问题修改,我们可在钉钉群中持续沟通~


特别说明

  1. 一次仅提交一个问题。不要将多个问题放在一次提交。
  2. 同样的问题在不同文档出现,如果多次提交,只算一个问题。
  3. 同一问题多人反馈,默认采纳提交时间最早的 pr。


以下问题视为无效:

问题无法定位

问题无法复现

问题非首次反馈

问题不符合验收标准

业务或产品建议类

非PC端问题反馈

其他经内部审核判定无效的情况


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



最后的最后,您有任何疑问都可以通过以下方式联系到我们~


联系我们

欢迎广大 OceanBase 爱好者、用户和客户随时与我们联系、反馈,方式如下:

社区版官网论坛

社区版项目网站提 Issue

钉钉群:33254054