文档提升计划 | 一起来打造更好的社区文档!

2024年 5月 7日 58.9k 0

文档提升计划 | 一起来打造更好的社区文档!-1

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

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

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

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

类型1:不规范和低错类

例如:

• 错别字

• 标点使用错误

• 文档格式错乱

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

例如:

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

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

类型3:内容错误

例如:

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

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

类型4 :内容缺失

例如:

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

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

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

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

02  为什么要加入贡献?

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

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

每一位参与者将获得社区积分,并将登上社区贡献者榜单

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

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

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

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

03  如何开始贡献?

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

您可以通过社区问答区或社群两个渠道参与:

通过社区问答区,了解参与攻略、活动详情及特别说明,详见链接

也可以加入钉钉社群,结识志同道合的小伙伴,了解文档活动进展,一起交流技术探讨与社区建设。

 

文档提升计划 | 一起来打造更好的社区文档!-2

扫码加入钉群

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

文档提升计划 | 一起来打造更好的社区文档!-3

相关文章

Oracle如何使用授予和撤销权限的语法和示例
Awesome Project: 探索 MatrixOrigin 云原生分布式数据库
下载丨66页PDF,云和恩墨技术通讯(2024年7月刊)
社区版oceanbase安装
Oracle 导出CSV工具-sqluldr2
ETL数据集成丨快速将MySQL数据迁移至Doris数据库

发布评论