3 Star 9 Fork 17

OceanBase / oceanbase-doc

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

文档提升计划第二期|OceanBase 邀您一起进行文档共建

项目地址:https://gitee.com/organizations/oceanbase/projects

你想快速学习更多知识吗?

你享受分享的快乐吗?

如果你的回答是 Yes

那么一起参与第二期文档提升计划吧!

6月1日,我们再度起航,欢迎热爱挑战、乐于分享的你一起开启文档共建旅程!

活动流程

活动时间:6月1日-6月30日

文档评审时间:7月1日-7月8日

结果公布+社区荣誉&激励:7月11日-7月15日

活动适用人群

提升学习效率,快速学习分布式数据库知识的学生

掌握 OceanBase 使用技能,想快速实现从入门到精通的 DBA

了解 OceanBase 功能模块及原理,从事数据库功能开发的人员

提升技术实力,考取 OBCP 认证的数据库从业者

活动收获

积累知识力量,形成个人成长体系

参与开源项目共建,结实志同道合的朋友

帮助社区新手用户更快上手 OceanBase

你提的建议一旦被采纳,你将成为社区贡献者,登上社区荣誉榜

同时,我们也准备了OBCP 考试券、露营帐篷、 颈椎枕头以及一些 OceanBase 周边及专属纪念品表示感谢。

参与方式

01 包含哪些任务类型?

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

类型1:不规范和低错类

例如:

• 错别字

• 标点使用错误

• 文档格式错乱

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

例如:

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

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

类型3:内容错误

例如:

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

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

类型4 :内容缺失

例如:

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

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

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

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

02 如何开始贡献?

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

03 如何参与贡献?

1、加入钉钉群

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

钉钉群号: 41203246

2、活动前准备

你需要拥有一个 gitee 账号。

3、活动中操作步骤

步骤:

  1. 登录到 Gitee 的 OceanBase 项目,https://gitee.com/oceanbase

  2. 找到想要提交问题的文档。

    Gitee 中 OceanBase 各个产品对应的文档仓库和地址如下。

    产品名 文档仓库名 仓库地址
    OceanBase 数据库 oceanbase-doc https://gitee.com/oceanbase/oceanbase-doc
    OceanBase 云平台(OCP) ocp-doc https://gitee.com/oceanbase/ocp-doc
    OceanBase 迁移服务(OMS) oms-doc https://gitee.com/oceanbase/oms-doc
    OceanBase 开发者中心(ODC) odc-doc https://gitee.com/oceanbase/odc-doc
    OBLOADER & OBDUMPER obdumper-loader-doc https://gitee.com/oceanbase/obdumper-loader-doc
    OceanBase Deployer obd-doc https://gitee.com/oceanbase/obd-doc
    OceanBase 数据库代理(ODP) oceanbase-proxy-doc https://gitee.com/oceanbase/oceanbase-proxy-doc
    OceanBase Connector/C oceanbase-connector-c-doc https://gitee.com/oceanbase/oceanbase-connector-c-doc
  3. 克隆本地分支。

  4. 修改内容并保存。

  5. 提交并生成 PR。

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

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

特别说明

  • 一次仅提交一个问题。不要将多个问题放在一次提交。

  • 同样的问题在不同文档出现,如果多次提交,只算一个问题。

  • 同一问题多人反馈,默认采纳提交时间最早的 pr。

以下问题视为无效:

  • 问题无法定位

  • 问题无法复现

  • 问题非首次反馈

  • 问题不符合验收标准

  • 业务或产品建议类

  • 非PC端问题反馈

  • 其他经内部审核判定无效的情况

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

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

oceanbase-doc文档仓库 展开 收起
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/oceanbase/oceanbase-doc.git
git@gitee.com:oceanbase/oceanbase-doc.git
oceanbase
oceanbase-doc
oceanbase-doc
V3.1.3

搜索帮助