Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: standardize community docs #474

Merged
merged 1 commit into from
Dec 17, 2024
Merged

docs: standardize community docs #474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/.vuepress/navbar/zh.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ export const zhNavbar = navbar([
children: [
{ text: '关于社区', link: '/zh/Community/About' },
{ text: '贡献指南', link: '/zh/Community/Development-Guide' },
{ text: '社区伙伴', link: '/zh/Community/Powered-By' },
{ text: '社区伙伴', link: '/zh/Community/Community-Partners' },
{ text: '交流与反馈', link: '/zh/Community/Feedback' },
{ text: '活动与报告', link: 'zh/Community/Materials' },
{ text: 'Commiters', link: '/zh/Community/Community-Project-Committers' },
{ text: '活动与报告', link: 'zh/Community/Events-and-Reports' },
{ text: 'Commiters', link: '/zh/Community/Committers' },
],
},
{
Expand Down
144 changes: 71 additions & 73 deletions src/Community/About-the-Community.md → src/Community/About.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
<!--

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software 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.

* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* 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.
-->

# About the Community

## Community Organization
Expand Down Expand Up @@ -54,66 +52,66 @@ Referring to the Apache Software Foundation's community philosophy, our communit

### PMC

- Get recommendations from existing PMC members
- Technical Expertise:
- Have a comprehensive understanding of the program
- Development Insight:
- Deep insight into the time-series database industry and the ability to grasp the direction of the project
- Cultural Alignment:
- Have a strong sense of open source culture, and contribute to the open source software advocacy
- Get recommendations from existing PMC members
- Technical Expertise:
- Have a comprehensive understanding of the program
- Development Insight:
- Deep insight into the time-series database industry and the ability to grasp the direction of the project
- Cultural Alignment:
- Have a strong sense of open source culture, and contribute to the open source software advocacy

### Committer

- Get recommendations from the existing PMC members
- Development Path
- Need to have complete understanding of a functional module
- Open Source Evangelist Path
- Contribute substantially to the open source advocacy of the project, e.g., contribute to technical documentation, provide and present user stories, actively participate in community exchanges and activities, etc.
- To understand the Apache Software Foundation's Code of Conduct (See [ASF Documentation](https://www.apache.org/foundation/policies/conduct.html)) In particular, they are committed to:
- Be open
- Be empathetic, welcoming, friendly, and patient
- Be collaborative
- Be inquisitive
- Be careful in the words that we choose
- Be concise
- Step down considerately
- Adhere to the responsibilities of an Apache Software Foundation’s committer (See the [ASF documentation](https://www.apache.org/dev/committers.html#committer-responsibilities))
- Help create a product that will outlive the interest of any particular volunteer, including themselves
- Maintain the health of the Apache community and help it grow
- Decide on release plans and releases
- Apply patches
- Help users
- Monitor commits and issues
- Help out with the website
- Practices that strengthen the IoTDB community
- Have a strong commitment to the project
- Share ideas with the community
- Take community feedback and integrate it into plans, designs, code, etc
- Be serious about trying to make IoTDB better through contributions
- Especially, if code contributors:
- are serious about trying to make IoTDB better through their code
- are serious about trying to make the IoTDB better through code reviews
- accept and integrate feedback about their code
- understand, adhere to, and continually optimize IoTDB best practices when reviewing/merging code (styles, documentation, tests, backward compatibility, etc.)
- Get recommendations from the existing PMC members
- Development Path
- Need to have complete understanding of a functional module
- Open Source Evangelist Path
- Contribute substantially to the open source advocacy of the project, e.g., contribute to technical documentation, provide and present user stories, actively participate in community exchanges and activities, etc.
- To understand the Apache Software Foundation's Code of Conduct (See [ASF Documentation](https://www.apache.org/foundation/policies/conduct.html)) In particular, they are committed to:
- Be open
- Be empathetic, welcoming, friendly, and patient
- Be collaborative
- Be inquisitive
- Be careful in the words that we choose
- Be concise
- Step down considerately
- Adhere to the responsibilities of an Apache Software Foundation’s committer (See the [ASF documentation](https://www.apache.org/dev/committers.html#committer-responsibilities))
- Help create a product that will outlive the interest of any particular volunteer, including themselves
- Maintain the health of the Apache community and help it grow
- Decide on release plans and releases
- Apply patches
- Help users
- Monitor commits and issues
- Help out with the website
- Practices that strengthen the IoTDB community
- Have a strong commitment to the project
- Share ideas with the community
- Take community feedback and integrate it into plans, designs, code, etc
- Be serious about trying to make IoTDB better through contributions
- Especially, if code contributors:
- are serious about trying to make IoTDB better through their code
- are serious about trying to make the IoTDB better through code reviews
- accept and integrate feedback about their code
- understand, adhere to, and continually optimize IoTDB best practices when reviewing/merging code (styles, documentation, tests, backward compatibility, etc.)

### Contributor

- Set up a development platform account:
- Create a Jira account: [https://issues.apache.org/jira/projects/IOTDB/issues](https://issues.apache.org/jira/projects/IOTDB/issues) to claim an issue.
- Create a Confluence account: [https://cwiki.apache.org/confluence/display/IOTDB/Home](https://cwiki.apache.org/confluence/display/IOTDB/Home). This will be used to write the design documentation.
Once created, send an email to the mailing list with **Introduction** and **Jira ID** and **Confluence ID** and the community PMC will add permissions to the account.
- Long Term Matters:
- Learn how to debug IoTDB
- [How to debug IoTDB server](https://my.oschina.net/u/3664598/blog/4500279)
- Understand the basics of using IoTDB
- [IoTDB download and installation](../UserGuide/latest/Deployment-and-Maintenance/IoTDB-Package_apache.md)
- [IoTDB Quick Start Guide](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart_apache.html)
- [Data Schema and Concepts](https://iotdb.apache.org/UserGuide/latest/Basic-Concept/Data-Model-and-Terminology.html)
- [API Interface](https://iotdb.apache.org/UserGuide/latest/API/Programming-Java-Native-API.html)
- Understand IoTDB's Internal Design
- [IoTDB Design Documentation](https://cwiki.apache.org/confluence/display/IOTDB/Home)
- Finding tasks to be done
- [Resolving Issues on Jira](https://issues.apache.org/jira/projects/IOTDB/issues)
- Set up a development platform account:
- Create a Jira account: [https://issues.apache.org/jira/projects/IOTDB/issues](https://issues.apache.org/jira/projects/IOTDB/issues) to claim an issue.
- Create a Confluence account: [https://cwiki.apache.org/confluence/display/IOTDB/Home](https://cwiki.apache.org/confluence/display/IOTDB/Home). This will be used to write the design documentation.
Once created, send an email to the mailing list with **Introduction** and **Jira ID** and **Confluence ID** and the community PMC will add permissions to the account.
- Long Term Matters:
- Learn how to debug IoTDB
- [How to debug IoTDB server](https://my.oschina.net/u/3664598/blog/4500279)
- Understand the basics of using IoTDB
- [IoTDB download and installation](../UserGuide/latest/Deployment-and-Maintenance/IoTDB-Package_apache.md)
- [IoTDB Quick Start Guide](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart_apache.html)
- [Data Schema and Concepts](https://iotdb.apache.org/UserGuide/latest/Basic-Concept/Data-Model-and-Terminology.html)
- [API Interface](https://iotdb.apache.org/UserGuide/latest/API/Programming-Java-Native-API.html)
- Understand IoTDB's Internal Design
- [IoTDB Design Documentation](https://cwiki.apache.org/confluence/display/IOTDB/Home)
- Finding tasks to be done
- [Resolving Issues on Jira](https://issues.apache.org/jira/projects/IOTDB/issues)

## Code of Conduct in the Apache Community

Expand Down Expand Up @@ -181,4 +179,4 @@ According to the instructions given by the Apache Software Foundation ([ASF Rele

#### Question 3: Is there a detailed guide for new RMs?

For new RMs, we provide detailed hands-on instructions. For a detailed description of what you need to do at each step, please see the "Release Management" section on this page.
For new RMs, we provide detailed hands-on instructions. For a detailed description of what you need to do at each step, please see the "Release Management" section on this page.
104 changes: 51 additions & 53 deletions src/Community/Commiters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,66 +1,64 @@
<!--

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software 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.

* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* 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.
-->

# Commiters

## Developers

### Project PMC
### Project PMC

| id | githubUsername | public name | starting date |
| -------------: | :-------------------: | :---------------: | :-----------: |
| wangchen | | Chen Wang | 2020/9/16 |
| cdutz | chrisdutz | Christofer Dutz | 2020/9/16 |
| liudw | liutaohua | Dawei Liu | 2020/9/16 |
| caogaofei | Beyyes | Gaofei Cao | 2020/9/16 |
| haonan | HTHou | Haonan Hou | 2020/9/16 |
| qiaojialin | qiaojialin | Jialin Qiao | 2020/9/16 |
| jimwang (*) | | Jianmin Wang | 2020/9/16 |
| jincheng | sunjincheng121 | Jincheng Sun | 2020/9/16 |
| xingtanzjr (*) | xingtanzjr | Jinrui Zhang | 2020/9/16 |
| jfeinauer | JulianFeinauer | Julian Feinauer | 2020/9/16 |
| yuanjun | | Jun Yuan | 2020/9/16 |
| jmclean | justinmclean, jmclean | Justin Mclean | 2020/9/16 |
| kmcgrail | | Kevin A. McGrail | 2020/9/16 |
| liukun | liukun4515 | Kun Liu | 2020/9/16 |
| leirui | LeiRui | Lei Rui | 2020/9/16 |
| kangrong | kr11 | Rong Kang | 2020/9/16 |
| liurui | liuruiyiyang | Rui Liu | 2020/9/16 |
| shuozhang | | Shuo Zhang | 2020/9/16 |
| zhaoxinyi (*) | StefanieZhao7 | Stefanie Zhao | 2020/9/16 |
| jiangtian | jt2594838 | Tian Jiang | 2020/9/16 |
| lta | fanhualta | Tianan Li | 2020/9/16 |
| ningjiang | WillemJiang | Willem Ning Jiang | 2020/9/16 |
| hxd | jixuan1989 | Xiangdong Huang | 2020/9/16 |
| chaow | mychaow | Chao Wang | 2021/6/2 |
| neuyilan | neuyilan | Houliang Qi | 2021/12/24 |
| jackietien | JackieTien97 | Yuan Tian | 2022/4/21 |
| wangchao316 | wangchao316 | Chao Wang | 2022/12/12 |
| rong | SteveYurongSu | Steve Yurong Su | 2023/9/28 |
| tanxinyu | OneSizeFitsQuorum | Xinyu Tan | 2023/9/28 |
| id | githubUsername | public name | starting date |
| --------------: | :-------------------: | :---------------: | :-----------: |
| wangchen | | Chen Wang | 2020/9/16 |
| cdutz | chrisdutz | Christofer Dutz | 2020/9/16 |
| liudw | liutaohua | Dawei Liu | 2020/9/16 |
| caogaofei | Beyyes | Gaofei Cao | 2020/9/16 |
| haonan | HTHou | Haonan Hou | 2020/9/16 |
| qiaojialin | qiaojialin | Jialin Qiao | 2020/9/16 |
| jimwang (\*) | | Jianmin Wang | 2020/9/16 |
| jincheng | sunjincheng121 | Jincheng Sun | 2020/9/16 |
| xingtanzjr (\*) | xingtanzjr | Jinrui Zhang | 2020/9/16 |
| jfeinauer | JulianFeinauer | Julian Feinauer | 2020/9/16 |
| yuanjun | | Jun Yuan | 2020/9/16 |
| jmclean | justinmclean, jmclean | Justin Mclean | 2020/9/16 |
| kmcgrail | | Kevin A. McGrail | 2020/9/16 |
| liukun | liukun4515 | Kun Liu | 2020/9/16 |
| leirui | LeiRui | Lei Rui | 2020/9/16 |
| kangrong | kr11 | Rong Kang | 2020/9/16 |
| liurui | liuruiyiyang | Rui Liu | 2020/9/16 |
| shuozhang | | Shuo Zhang | 2020/9/16 |
| zhaoxinyi (\*) | StefanieZhao7 | Stefanie Zhao | 2020/9/16 |
| jiangtian | jt2594838 | Tian Jiang | 2020/9/16 |
| lta | fanhualta | Tianan Li | 2020/9/16 |
| ningjiang | WillemJiang | Willem Ning Jiang | 2020/9/16 |
| hxd | jixuan1989 | Xiangdong Huang | 2020/9/16 |
| chaow | mychaow | Chao Wang | 2021/6/2 |
| neuyilan | neuyilan | Houliang Qi | 2021/12/24 |
| jackietien | JackieTien97 | Yuan Tian | 2022/4/21 |
| wangchao316 | wangchao316 | Chao Wang | 2022/12/12 |
| rong | SteveYurongSu | Steve Yurong Su | 2023/9/28 |
| tanxinyu | OneSizeFitsQuorum | Xinyu Tan | 2023/9/28 |

### Project Committers
### Project Committers

| **id** | **githubUsername** | **public name** |
| :----------: | :----------------: | :-------------: |
| bensonchou | | Peichen Chou |
| bensonchou | | Peichen Chou |
| chenyz | Cpaulyz | Yanze Chen |
| dope | myxof | Yi Xu |
| east | mdf369 | DongFang Mao |
Expand Down Expand Up @@ -91,4 +89,4 @@
| yongzao | crzbulabula | Yongzao Dan |
| yschengzi | | Sicheng Yu |
| yuyuankang | yuyuankang | Yuyuan Kang |
| zyk | MarcosZyk | Yukun Zhou |
| zyk | MarcosZyk | Yukun Zhou |
Loading
Loading