OceanBase 社区版文档捉虫活动来啦!

OceanBase 社区版 3.1.3 作为 2022 年首个版本,已于 3 月 30 日正式发布。此次版本的重大更新离不开社区用户的反馈和需求。因为社区用户的帮助与支持,本次版本提升了部署便捷性、易用性、稳定性,现文档也已全部开放。


文档是帮助用户更好地使用新版本的重要一环。OceanBase 开源社区正式发起文档提升计划,邀您一起打造更加丝滑的文档体验。无论你是第一次接触 OceanBase 的用户还是深度用户,都欢迎参与此次计划。在参与过程中,你可以感受到文档一点点被打磨被完善的过程,感受到所提的建议被采纳的快乐。



01 计划包含哪些任务类型?


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


类型1:不规范和低错类

例如:

• 错别字

• 标点使用错误

• 文档格式错乱


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

例如:

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

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


类型3:内容错误

例如:

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

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


类型4 :内容缺失

例如:

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

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


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


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




02 为什么要加入贡献?


关于为什么要参加社区文档提升计划,有三大原因:



第一,与数百位社区贡献者一起,建设更好的文档

如果遇到任何问题,你都可以与社区热心的技术大神、热情的贡献者、经验丰富的技术专家一起交流,你可以感受到交流讨论迸发的灵感,体会到各种问题被快速暴露并被推动解决的快乐。


第二,通过丰富的社区资料,快速提升你的技能

社区文档包括了使用手册、开发教程、术语、概念、架构原理等,能帮助你快速熟悉 OceanBase 有关技术知识,快速上手,获取实践经验。


第三,OceanBase 开源社区积分荣誉

每一位参与者将获得社区积分,并将登上社区贡献者榜单。我们也准备了 OceanBase 专属纪念品感谢大家的热情参与。


03 如何开始贡献?


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






活动攻略

1、加入钉钉群

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

钉钉群号:41203246



2、活动前准备

你需要拥有一个 Github 账号,具体操作参见 https://docs.github.com/cn/get-started/signing-up-for-github/signing-up-for-a-new-github-account


3、活动中操作步骤

1)登录 oceanBase 社区版官网文档:https://open.oceanbase.com/docs/productDocs

2)进入具体文档页面,查看文档。如文档中存在问题,单击 编辑

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

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

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


也可以看视频了解参与步骤哦~

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


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


特别说明

  • 一次仅提交一个问题。不要将多个问题放在一次提交。
  • 同样的问题在不同文档出现,如果多次提交,只算一个问题。
  • 同一问题多人反馈,默认采纳提交时间最早的 pr。
  • 以下问题视为无效:
  • 问题无法定位
  • 问题无法复现
  • 问题非首次反馈
  • 问题不符合验收标准
  • 业务或产品建议类
  • 非PC端问题反馈
  • 其他经内部审核判定无效的情况
3 个赞

前排

1 个赞

这里是不是应建议用192.168.x.x呀

2 个赞

群貌似还加不了

正好学习OBCP,在看一遍文档,顺便抓虫喽

应该可以了的,你再试下

1 个赞

群貌似还加不了



开始捉虫


1 个赞

可以加啦

实践出真知,在使用中才能更快发现问题,大家多多支持呀

666

开始捉虫


一起来捉虫~

1 个赞

一起来捉虫~

1 个赞

捉到虫啦

3 个赞

燥起来~

1 个赞

我之前好像发现了几处,当时想编辑不知道咋弄,就忘了

1 个赞

已采纳修改,感谢喔~