与社区携手,共建文档攻略,欢迎大家随时补充~

为进一步提升 OceanBase 社区各文档的完备性和规范性,给用户带来更好的线上体验,OceanBase 诚邀你参与文档共建!

提交内容

在阅读 OceanBase 社区文档时,如果你遇到以下错误,欢迎提交至GitHub、Gitee、社区、钉群(群号:41203246)。

类型1:不规范和低错类

• 错别字

• 标点使用错误

• 文档格式错乱

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

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

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

类型3:内容错误

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

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

类型4 :内容缺失

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

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

更多建议等你来反馈~

提交方式

在 OceanBase 进行问题提报有三种方式。

方式一:社区内提报

进入 OceanBase 社区,选中要反馈的内容,单击文档反馈 ,在弹出的页面中填写你的宝贵建议。

Tips:为方便大家提建议,文档最后也放有问题反馈栏。

方式二: GitHub 提报

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

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

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

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

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

方式三:钉群内错误提报。 群号:41203246,或扫下方二维码

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

希望与社区更多的小伙伴们一起加油,让文档成为大家最好用的工具书,帮助大家快速解决问题。快来加入文档共建者专属社群吧~

太棒了,希望更多的人在学习了解OB的过程中,也动动小手参与到文档共建中来~

:+1::+1::+1:聚沙成塔~

我要积极参与!