initial commit

CODE_OF_CONDUCT.md

@@ -0,0 +1,45 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity, and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality about the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4.
+
+For answers to common questions about this code of conduct, see [FAQ](https://www.contributor-covenant.org/faq).

LICENSE

@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

README.md

@@ -0,0 +1,22 @@
+# OceanBase Developer Community
+
+Welcome to the OceanBase developer community!
+
+Welcome to join the OceanBase developer community and contribute. Document improvements, code contributions, or participation in discussions are all welcome.
+
+## Organization
+There are two types of organizations in the OceanBase developer community.
+- [Technical Oversight Committee (TOC)](toc/README_CN.md)(Chinese): The technical management organization of the OceanBase developer community, responsible for the resolution of major technical and community events related to the OceanBase developer community.
+- [Special Interest Group(SIG)](sigs/README_CN.md)(Chinese): An open working group established for one or more specific technical topics. The SIG should be open and transparent, and anyone is welcome to join and contribute. Contributors should follow the [Community Code of Conduct](./CODE_OF_CONDUCT.md). A SIG manages one or more community projects.
+
+Changes to the organizational structure and related information changes will be made through voting. For details, please refer to [Voting Information](votes/README_CN.md)(Chinese).
+
+## Communication Channels
+* [Slack Workspace](https://join.slack.com/t/oceanbase/shared_invite/zt-1e25oz3ol-lJ6YNqPHaKwY_mhhioyEuw)
+* [Stack Overflow](https://stackoverflow.com/questions/tagged/oceanbase)
+* [Chinese Forum](https://ask.oceanbase.com/)
+* DingTalk group: 33254054 ([QR code](images/dingtalk.svg))
+* WeChat group (Add the assistant with WeChat ID: OBCE666)
+
+## License
+OceanBase Community is licensed under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.

README_CN.md

@@ -0,0 +1,22 @@
+# OceanBase 开发者社区
+
+欢迎来到 OceanBase 开发者社区！
+
+欢迎加入 OceanBase 开发者社区并参与贡献，文档改进、贡献代码或者参与讨论都非常欢迎。
+
+## 组织架构
+OceanBase 开发者社区中有两种类型的组织。
+- [Technical Oversight Committee(TOC)](toc/README_CN.md): OceanBase 开发者社区的技术管理机构，负责 OceanBase 开发者社区相关的技术类和社区重大事件决议。
+- [Special Interest Group(SIG)](sigs/README_CN.md): 针对特定的一个或多个技术主题而成立的开放性工作组。SIG 应该开放并且透明，欢迎任何人加入与贡献，贡献者应遵循[社区行为组织规范](./CODE_OF_CONDUCT.md)。一个SIG管理一个或多个社区项目。
+
+当前社区中的信息变更，都会通过投票来进行，具体请参考 [投票信息](votes/README_CN.md)。
+
+## 交流渠道
+* [Slack Workspace](https://join.slack.com/t/oceanbase/shared_invite/zt-1e25oz3ol-lJ6YNqPHaKwY_mhhioyEuw)
+* [Stack Overflow](https://stackoverflow.com/questions/tagged/oceanbase)
+* [中文论坛](https://ask.oceanbase.com/)
+* 钉钉群: 33254054 ([QR code](images/dingtalk.svg))
+* 微信群 (Add the assistant with WeChat ID: OBCE666)
+
+## 许可证
+OceanBase Community 采用 Apache 2.0 许可。有关详细信息，请参阅 [LICENSE](LICENSE) 文件。

sigs/README_CN.md

@@ -0,0 +1,46 @@
+# Special Interest Group(SIG)
+
+SIG 的全称是 Special Interest Group，即特别兴趣小组。SIG 必须保持开放透明的原则，通过会议分享、项目开发等活动促进技术交流。欢迎任何新人加入 SIG 并作出贡献。
+
+## 加入一个 SIG
+如果你对某个领域的话题感兴趣，可以申请加入或关注对应的 SIG。通常 SIG 都有自己的周期性会议、日常沟通群，你可以先参加相关的活动，然后按照对应 SIG 的规定申请加入。
+
+## 创建新的SIG
+如果你有新的想法，当前的SIG列表中没有满足你兴趣的 SIG，你可以提出申请创建新的 SIG。请参考下面的申请流程。
+
+注意：SIG 应遵守 [SIG规则](./governance.md)。
+
+**申请流程**
+
+- 提交PR到 [oceanbase/community](https://github.com/oceanbase/community) 仓库，标题为 "SIG Charter Proposal: <your sig-name>"；
+- 增加新的 SIG 目录，复制[SIG模板](./sig-template/)，修改目录名为`community/sigs/sig-<sig-name>`，例如`community/sigs/sig-obdiag`，填写模板内容；
+- 填写[投票信息](../votes/README_CN.md)；
+- 填写 README 文件和 membership.yml 文件。其中 membership.yml 文件填写 Maintainer 信息，和各个项目中的 Committer 信息；
+- 按照 review 意见调整 PR 内容；
+- 不少于 2/3 TOC 成员审批通过后，PR 会被 merge，SIG 正式成立。必要时会邀请你参会讨论。
+
+## 更新SIG信息
+
+SIG 信息变更的内容不同，需要由不同角色的人来审核。
+以下内容变更需要由 TOC 成员(不少于 2/3 通过)审核，其它的由 SIG Maintainer(不少于 2/3 通过) 审核。
+- SIG Maintainer 成员变更；
+- SIG 项目列表变更；
+
+**变更流程**
+
+> 这里说明 SIG 普通信息的变更，membership 变更流程请参考 [membership变更流程](./membership.md)。
+
+- 提交PR到[oceanbase/community](https://github.com/oceanbase/community)仓库，PR 标题 `SIG Update: <your sig-name>"`；
+- 并填写[投票信息](../votes/README_CN.md)；
+- 投票通过后 PR 会被 merge，变更成功。
+
+## 结束SIG
+由于某些原因，SIG没有存在的必要性，可以结束 SIG。
+
+**结束流程**
+- 提交 PR 到[oceanbase/community](https://github.com/oceanbase/community)仓库，PR 标题为 "SIG Termination: <your sig-name>"，
+- 将 sig 目录放入 `community/sigs/archive-sigs` 目录；
+- 不少于  2/3 TOC 审批通过后，PR 会被 merge，SIG 终结。
+
+## sigs 目录文件说明
+`sigs` 目录，也就是当前目录，存放所有 SIG 组织，`sig-template` 目录存放创建新的 SIG 时的模板文件，archive-sigs 存放不再活跃的 SIG，其余目录以 `sig-<name>` 命名，记录某个 SIG 的信息。普通的 SIG 最少包含两个文件，README 和 membership.yml文件，分别记录 SIG 的信息，比如兴趣组的目标、交流渠道等，membership.yml 文件记录该组的 Maintainer 和各个仓库的 Committer 信息。

sigs/archive-sigs/README_CN.md

@@ -0,0 +1 @@
+这个目录放生命周期终止的 SIG 目录。

sigs/governance.md

@@ -0,0 +1,17 @@
+# SIG 申请与运营的注意事项
+
+## 运营
+- 必须将设计开发资料必须在社区开放，可以放在[语雀](https://oceanbase.yuque.com/dashboard/org_wiki)或GitHub上；
+- 必须包含开发者新手指南。新人上手文档，比如如何编译、如何运行和测试、应该遵守的规则。建议增加一些合适的 good first issue，方便新开发者参与。good first issue 也是吸引新 contributor 的有效方式；
+- 必须说明日常交流方式。
+  - 建议周期性开会交流，将会议信息放在公开处；
+  - 建议使用IM交流工具，方便日常交流；
+  - 建议将重要信息进行归档，放在文档区域。
+- 必须拥有规范的 GitHub 运营机制：issue 标签、响应机制、pull request 响应机制；
+- 建议使用 GitHub project 功能管理项目进度，使用 issue 进行任务管理，使用 milestone 进行版本管理；
+
+## 角色
+
+- 必须说明成员角色的职责、权限。
+- 必须说明成员变更流程。必须说明如何加入，如何退出；每个角色如何变更，如何申请；
+- 最少有3个成员。

sigs/membership.md

@@ -0,0 +1,88 @@
+# SIG 组织架构说明
+
+本篇文档提供一个默认的 SIG 组织架构，包括 SIG 的职责、权限、申请条件、申请流程、退出条件等，各个 SIG 可以参考本篇文档直接使用或在此基础上进行修改或说明变更。
+
+SIG 组织架构信息可以在各SIG目录的README和 membership.yml 文件中找到。
+
+## Maintainer
+
+通常由 1~3 人组成，可以有一个主要负责人，一些人协助。
+
+### 职责
+
+- 项目目标制定。制定项目 roadmap
+- 项目管理。积极推进项目成功落地
+- 社区建设。比如组织会议、文档管理规范、开发流程规范
+- 成员指导。指导组内成员参与项目方案制定与研发
+
+> 这里描述了多个任务，某个 Maintainer 可能只做其中一项任务
+
+
+### 权限
+
+与职责对等的权限，此外还有 Committer 的所有权限
+
+### 申请条件
+满足下面其中一个条件，可以由 Maintainer 发起申请。
+
+- 身份为 Committer 最少半年
+- 主导实现最少1个核心 feature 开发，或在某个项目中给出过方向性指导意见
+
+### 申请
+
+自己提交申请或由 SIG Maintainer 发起提议，不少于 2/3 TOC 审核通过。
+
+### 退出
+
+Maintainer 不再活跃或不能再参与相关项目，可以由自己或其他 Maintainer 发起退出成员变更流程，不少于 2/3 TOC 审批通过后。
+
+### 特殊情况
+
+如果某个外部成员在日常活动中给出过重大指导意见或类似重大贡献，可以由 Maintainer 提议，由 TOC review 通过后合并 PR，将其加入 SIG Maintainer 列表。
+
+## Committer
+### 职责
+- 某模块的主要功能设计、研发
+- review 他人方案设计、代码
+- 指导 contributor 和新人修复 BUG、实现 feature
+- 积极参与小组相关议题讨论
+### 权限
+拥有特定模块代码合并的权限、拥有拒绝合并代码的权限
+
+> 如果该 Committer 不负责开发，则不赋予其代码合并权限
+
+### 申请
+满足以下所有条件，可以由 Committer 或 Maintainer 发起申请，由不少于 2/3 Maintainer 审核通过。
+- 身份为 Contributor；
+- 最少修复过3个重大 BUG 或提交1个某个核心模块 feature，或在某项目中给出过重要指导意见(需要有记录)；
+
+### 退出
+满足下面其中一个条件，可以由自己或 Maintainer 发起退出成员变更流程。
+
+- 成员无法参与项目；
+- 半年内没有参与对应职责对应的活动。
+
+## Contributor
+### 职责
+- 参与项目的开发、BUG修复
+- 积极参与项目方案、议题的讨论
+
+### 权限
+
+可以参与SIG的日常交流，提出建议、贡献代码
+
+### 申请
+满足下面其中一个条件，由本人申请或由 SIG Maintainer 发起提议，不少于 2/3 Maintainer 审核通过。
+- 成功提交过1个PR
+- 提交过相关项目的设计方案
+
+### 退出
+满足下面其中一个条件，可以由自己、Committer 或 Maintainer 发起退出成员变更流程。
+
+- 成员无法参与项目；
+- 半年内没有参与过任何活动。
+
+## 成员变更流程
+- 在[oceanbase/community](https://github.com/oceanbase/community)中发起成员变更PR，PR 标题为 `SIG Membership Change: {name} ({role})`；
+- 增加[投票记录](../votes/README_CN.md)；
+- 审核通过后合并 PR，即变更成功。

sigs/sig-obdiag/README_CN.md

@@ -0,0 +1,74 @@
+# SIG obdiag
+
+## obdiag 简介
+
+OceanBase Diagnostic Tool (obdiag) 是一款专门OceanBase打造的敏捷诊断工具，功能包括诊断信息收集、分析、巡检，可以在 OceanBase 集群不同的部署模式下（OCP，OBD 或用户根据文档手工部署）实现一键执行。
+
+### 项目价值
+OceanBase 是原生分布式数据库系统，故障根因分析通常是比较繁琐的，因为涉及的因素可能有很多，如机器环境、配置参数、运行负载等等。专家在排查问题的时候需要获取大量的信息来分析故障，如何高效的获取故障场景下分散在各个节点的信息，挖掘出其中的关联性，帮助用户自助诊断问题便是 obdiag 的价值。
+
+![Project Value](images/value.png)
+
+### 特性
+
+#### 产品特性
+obdiag 定位为 OceanBase 敏捷诊断工具。整体使用上备以下的特点：
+
+- 极致轻量：提供rpm 包和 OBD 上部署的模式，均可一键部署安装，rpm 包才不到 30MB 大小。可以选择部署到任意一台能连接到集群各个节点的上，并不局限于 OBServer 节点。
+- 简单易用：一条命令搞定安装，一键集群巡检、一键信息收集、一键诊断分析、一键根因分析等功能全部可以通过一条命令搞定，简单易用。
+- 完全开源：obdiag 是 Python 代码开发的，源代码100%开源，github 地址仓库：https://github.com/oceanbase/obdiag
+- 高度可扩展：obdiag 的一键巡检功能、一键场景化信息收集功能、一键根因分析功能都是插件化的，用户可自行低成本的添加场景来定制化诊断的场景。
+
+![features](images/features.png)
+
+#### 功能特性
+obdiag 现有功能包含了对于 OceanBase 日志、SQL Audit 以及 OceanBase 进程堆栈等信息进行的扫描、收集、分析、诊断，可以在 OceanBase 集群不同的部署模式下（OCP，OBD 或用户根据文档手工部署）实现一键诊断执行。
+![function features](images/function-features.png)
+
+obdiag的功能如下：
+- 一键集群巡检：使用 obdiag check 命令可帮助 OceanBase 数据库集群相关状态巡检，目前支持从系统内核参数、内部表等方式对 OceanBase 的集群进行分析，发现已存在或可能会导致集群出现异常问题的原因分析并提供运维建议。
+- 一键诊断分析：使用 obdiag analyze 命令可帮助 OceanBase 数据库相关的诊断信息分析，目前支持对 OceanBase 的日志进行一键分析，找出发生过的错误信息；一键全链路诊断分析，展示全链路诊断树，定位链路慢在何处。
+- 一键信息收集：使用 obdiag gather 命令可帮助 OceanBase 数据库相关的诊断信息收集。目前支持基础诊断信息收集和基于场景的诊断信息一键收集。
+- 一键根因分析：使用 obdiag rca 命令可帮助 OceanBase 数据库相关的诊断信息分析，目前支持对 OceanBase 的异常场景进行分析，找出可能导致问题的原因。
+
+## 关联的代码仓库
+
+- [obdiag](https://github.com/oceanbase/obdiag)
+
+## 语雀文档
+[obdiag 语雀空间](https://oceanbase.yuque.com/org-wiki-obtech-vh7w9r/imzr6c/rhg09211pih0aomx)
+
+## 联系信息
+
+周会信息：每周举行一次线上周会，会议时间初定每周五 16:00-17:00。会议纪要记录到外网语雀文档和 GitHub 中
+周会归档：[周会记录](https://oceanbase.yuque.com/org-wiki-obtech-vh7w9r/imzr6c/pa2ny21mpif09xot)
+
+微信群：专用微信群【[SIG] OceanBase 诊断工具兴趣小组】，便于成员随时讨论问题，微信群添加方式，添加微信：obdiagsig，说明加群目的，审核通过后管理员会将加用户加入微信群中。
+
+## 组织架构
+> 我们要求成立一个SIG，最少有3个人
+
+成员角色说明完全参照[成员角色说明](../membership.md)，没有变更。
+
+### Maintainer
+
+- 白鳝(xuji755), 南京基石数据
+- 汤庆(Teingi), OceanBase
+- 傅榕锋(frf12), OceanBase
+
+### Committer
+
+- 王煦焱(wayyoungboy), OceanBase
+
+### Contributor
+
+- 肖兵
+- 岳艳涛
+- 藏强磊
+- 陈海英
+- 杜振鹏
+- 洪云飞
+- 靖永栋
+- 邱永刚
+- 孙鹏
+- 唐素珍

sigs/sig-obdiag/membership.yml

@@ -0,0 +1,20 @@
+maintainers:
+- github_id: xuji755
+  name: 白鳝
+  organization: 南京基石数据
+- github_id: Teingi
+  name: 汤庆
+  organization: OceanBase
+- github_id: frf12
+  name: 傅榕锋
+  organization: OceanBase
+repositories:
+- repo:
+  - oceanbase/obdiag
+  committers:
+  - github_id: wayyoungboy
+    name: 王煦焱
+    organization: OceanBase
+  - github_id: Teingi
+    name: 汤庆
+    organization: OceanBase

sigs/sig-template/README_CN.md

@@ -0,0 +1,43 @@
+# SIG <sig-name>
+
+## SIG 简介
+
+这里应该填写相应 SIG 的简介，比如该SIG想要解决的问题、目标、愿景等。
+
+## 项目列表
+
+- [oceanbase/oceanbase](https://github.com/oceanbase/oceanbase)
+- [oceanbase/community](https://github.com/oceanbase/community)
+
+## 语雀文档
+> 如果有的话
+
+## 联系信息
+
+周会信息（如果有的话）：每周周五下午4点（北京时间）
+周会归档：[周会记录](https://oceanbase.yuque.com/org-wiki-obtech-vh7w9r/imzr6c/sm9xzu63xq2688wz)
+
+微信群：添加xxx，备注“SIG-xxx”，等待邀请入群
+
+## 组织架构
+> 我们要求成立一个SIG，最少有3个人
+
+成员角色说明完全参照[成员角色说明](../membership.md)，没有变更。
+
+### Maintainer
+
+- 姓名1(@github-id1), 所在组织
+- 姓名2(@github-id2), 所在组织
+- 姓名3(@github-id3), 所在组织
+
+### Committer
+
+- 姓名1(@github-id1), 所在组织
+- 姓名2(@github-id2), 所在组织
+- 姓名3(@github-id3), 所在组织
+
+### Contributor
+
+- 姓名1(@github-id1), 所在组织
+- 姓名2(@github-id2), 所在组织
+- 姓名3(@github-id3), 所在组织