{"id":29571853,"url":"https://github.com/oceanbase/oceanbase-doc","last_synced_at":"2025-07-19T04:36:20.351Z","repository":{"id":37371975,"uuid":"451415113","full_name":"oceanbase/oceanbase-doc","owner":"oceanbase","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-17T23:56:09.000Z","size":145461,"stargazers_count":30,"open_issues_count":1,"forks_count":124,"subscribers_count":8,"default_branch":"V4.3.5","last_synced_at":"2025-07-18T03:01:12.770Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oceanbase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-01-24T10:20:19.000Z","updated_at":"2025-06-29T10:04:02.000Z","dependencies_parsed_at":"2024-05-05T09:32:49.403Z","dependency_job_id":"051f2572-64ce-4544-a5b9-e379fe7566f4","html_url":"https://github.com/oceanbase/oceanbase-doc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/oceanbase/oceanbase-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Foceanbase-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Foceanbase-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Foceanbase-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Foceanbase-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oceanbase","download_url":"https://codeload.github.com/oceanbase/oceanbase-doc/tar.gz/refs/heads/V4.3.5","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Foceanbase-doc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265889155,"owners_count":23844539,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-19T04:36:19.866Z","updated_at":"2025-07-19T04:36:20.344Z","avatar_url":"https://github.com/oceanbase.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# OceanBase 数据库文档\n\n欢迎访问 OceanBase 数据库文档。您可以在本仓库中查看 OceanBase 数据库的中英文文档。\n\n* `zh-CN` 文件夹下存放的是 OceanBase 数据库的中文文档\n\n* `en-US` 文件夹下存放的是 OceanBase 数据库的英文文档\n\nOceanBase 欢迎大家随时参与到文档的共同建设中，OceanBase 文档的贡献者可以：\n\n* 提交文档问题或者建议\n\n* 优化已有的内容\n\n* 编写新的内容\n\n\n## 贡献文档\n\n### 开始之前\n\n感谢您对 OceanBase 数据库文档的贡献兴趣。为厘清就个人或实体贡献内容而授予的知识产权许可，我们必须对每位贡献者签署的贡献者许可协议（Contributor Licence Agreement，简称 CLA）（“CLA”）进行归档，以证明就 CLA 达成的一致。点击 [OceanBase CLA](https://cla-assistant.io/oceanbase/oceanbase?pullRequest=108)，点击 **Sign in with GitHub to agree** 按钮签署协议。\n\n### 贡献指南\n\n您可以按照以下步骤提交 Pull Request（简称 PR）：\n\n**步骤 1：Fork 项目仓库**\n\n1. 访问 OceanBase 数据库文档的 [GitHub 地址](https://github.com/oceanbase/oceanbase-doc)。\n\n2. 点击 Fork 按钮创建远程分支。\n\n**步骤 2：克隆分支到本地**\n\n1. 定义工作目录。\n\n   ```bash\n   # 定义工作目录\n   working_dir=$HOME/Workspace\n   ```\n\n2. 配置 GitHub 用户名。\n\n   ```bash\n   user={GitHub账户名}\n   ```\n\n3. 克隆代码。\n\n   ```bash\n   # 克隆代码\n   mkdir -p $working_dir\n   cd $working_dir\n   git clone git@github.com:$user/oceanbase-doc.git\n   # 或: git clone https://github.com/$user/oceanbase-doc.git\n   \n   # 添加上游分支\n   cd $working_dir/oceanbase-doc\n   git remote add upstream git@github.com:oceanbase/oceanbase-doc.git\n   # 或: git remote add upstream https://github.com/oceanbase/oceanbase-doc.git\n   \n   # 为上游分支设置 no_push\n   git remote set-url --push upstream no_push\n   \n   # 确认远程分支有效\n   git remote -v\n   ```\n\n**步骤 3：创建新分支**\n\n1. 更新本地分支。\n\n   ```bash\n   cd $working_dir/oceanbase-doc\n   git fetch upstream\n   git checkout $branch\n   git rebase upstream/$branch\n   ```\n\n2. 基于本地 $branch 分支创建新分支。\n\n   ```bash\n   git checkout -b new-branch-name\n   ```\n\n**步骤 4：修改/添加/删除文档**\n\n在 `new-branch-name` 上修改文档并保存更改。\n\n**步骤 5：提交更改**\n\n```bash\n# 检查本地文件状态\ngit status\n\n# 添加您希望提交的文件\n# 如果您希望提交所有更改，直接使用 `git add .`\ngit add \u003cfile\u003e ... \ngit commit -m \"commit-message: update the xx\"\n```\n\n**步骤 6：保持开发分支与上游分支同步**\n\n```bash\n# 在开发分支执行以下操作\ngit fetch upstream\ngit rebase upstream/branch\n```\n\n**步骤 7：推送更改至远程分支**\n\n```bash\n# 在开发分支执行以下操作\ngit push -u origin new-branch-name\n```\n\n**步骤 8：创建 PR**\n\n1. 访问您 Fork 的仓库。\n\n2. 单击 `new-branch-name` 分支旁的 `Compare \u0026 pull request` 按钮。\n\n以上就是参与 OceanBase 数据库文档共建的步骤，如果在此过程中遇到任何问题，可以加入我们唯一官网钉钉群：41203246，与社区热心的技术大神、热情的贡献者、经验丰富的技术专家一起交流、探讨问题。","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foceanbase%2Foceanbase-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foceanbase%2Foceanbase-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foceanbase%2Foceanbase-doc/lists"}