4.5 KiB

Raw Blame History

2021年6月1日，OceanBase 数据库正式开源，采用业界通用的 Open Core 模式，将 OceanBase 数据库内核、分布式组件和接口驱动完全开源，共开源 300 万行代码，包括 SQL 引擎、事务引擎和存储引擎，支持多副本、分布式事务、高性能、扩展能力、故障恢复、优化器、多活容灾、语法兼容等核心技术。截至目前，已有 33000 社区用户，128+ 全球核心代码贡献者，超过200+ 企业客户深入探索使用，致力于构建我国自有产权的数据库产品技术路线和生态体系。

自开源以来，OceanBase 社区先后迭代发布社区版 3.1.0、3.1.1、3.1.2、3.1.3 和 3.1.4。从早期只有数据库内核和最基本的一键安装部署工具的首个 3.1.0 版本，到开源半年内先后发布的 3.1.1、3.1.2 和 3.1.3 三个版本，提供 OceanBase 生态工具社区版支持（包括运维管理工具OCP、开发者工具ODC、数据同步工具OMS、导入导出工具 obdumper/obloader 等），再到开启多模数据类型、JSON支持、兼容HBase API，让生态有更多可能。

OceanBase 社区的成长离不开开放和共享，更离不开每一位社区用户的建议和贡献。感谢每一位喜欢 OceanBase 并为其提出建议、作出贡献的朋友，也欢迎更多社区用户一起创造更好的开源产品，并完善产品文档，为每一位用户提供更好的阅读体验！

以下为 OceanBase 数据库文档的介绍及共建此文档的方法。

OceanBase 数据库文档

欢迎访问 OceanBase 数据库文档。您可以在本仓库中查看 OceanBase 数据库的中英文文档。

zh-CN 文件夹下存放的是 OceanBase 数据库的中文文档
en-US 文件夹下存放的是 OceanBase 数据库的英文文档

贡献文档

开始之前

感谢您对 OceanBase 数据库文档的贡献兴趣。为厘清就个人或实体贡献内容而授予的知识产权许可，我们必须对每位贡献者签署的贡献者许可协议（Contributor Licence Agreement，简称 CLA）（“CLA”）进行归档，以证明就CLA达成的一致。点击 OceaBase CLA，点击 Sign in with GitHub to agree 按钮签署协议。

贡献指南

您可以按照以下步骤提交 Pull Request（简称 PR）：

步骤 1：Fork 项目仓库

访问 OceanBase 数据库文档的 GitHub 地址。
点击 Fork 按钮创建远程分支。

步骤2：克隆分支到本地

定义工作目录。

# 定义工作目录
working_dir=$HOME/Workspace

配置 GitHub 用户名。
```
user={GitHub账户名}
```

克隆代码。

# 克隆代码
mkdir -p $working_dir
cd $working_dir
git clone git@github.com:$user/oceanbase-doc.git
# 或: git clone https://github.com/$user/oceanbase-doc.git

# 添加上游分支
cd $working_dir/oceanbase-doc
git remote add upstream git@github.com:oceanbase/oceanbase-doc.git
# 或: git remote add upstream https://github.com/oceanbase/oceanbase-doc.git

# 为上游分支设置 no_push
git remote set-url --push upstream no_push

# 确认远程分支有效
git remote -v

步骤 3：创建新分支

更新本地分支。

cd $working_dir/oceanbase-doc
git fetch upstream
git checkout $branch
git rebase upstream/$branch

基于本地 $branch 分支创建新分支。
```
git checkout -b new-branch-name
```

步骤 4：修改/添加/删除文档

在 new-branch-name 上修改文档并保存更改。

步骤 5：提交更改

# 检查本地文件状态
git status

# 添加您希望提交的文件
# 如果您希望提交所有更改，直接使用 `git add .`
git add <file> ... 
git commit -m "commit-message: update the xx"

步骤 6：保持开发分支与上游分支同步

# 在开发分支执行以下操作
git fetch upstream
git rebase upstream/branch

步骤 7：推送更改至远程分支

# 在开发分支执行以下操作
git push -u origin new-branch-name

步骤 8：创建 PR

访问您 Fork 的仓库。
单击 new-branch-name 分支旁的 Compare & pull request 按钮。

以上就是参与OceanBase 数据库文档共建的步骤，如果在此过程中遇到任何问题，可以加入我们唯一官网钉钉群：41203246，与社区热心的技术大神、热情的贡献者、经验丰富的技术专家一起交流、探讨问题。

4.5 KiB Raw Blame History Unescape Escape

OceanBase 数据库文档

贡献文档

开始之前

贡献指南

4.5 KiB

Raw Blame History