Skip to content

Commit 3d2a122

Browse files
Update community onboarding documentation (#1173)
* Update community onboarding documentation The Contributor onboarding section referenced a personal blog post from ~6 years ago for "how to debug IoTDB server", which no longer matches the current codebase (reported in discussion #17575). Replace it with the maintained README and Development Guide, and restructure the section into a clear path: set up accounts -> get the code running -> understand the design -> pick a task. Also fix the WeChat official account name in the Chinese channel page (it was outdated) and remove the discontinued DingTalk group entry. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * Emphasize mailing list and tidy onboarding links Make the developer mailing list the primary entry point for new contributors instead of leading with Jira/Confluence accounts. For finding tasks, list GitHub Issues before Jira. Replace the Confluence design-doc pointer with guidance to read the source together with the README, since the Confluence space is no longer actively maintained. Also convert the "download and installation" link from a relative path to the official website URL, consistent with the other links in the section. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 29faf03 commit 3d2a122

3 files changed

Lines changed: 58 additions & 35 deletions

File tree

src/Community/About-the-Community.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -96,22 +96,34 @@ Referring to the Apache Software Foundation's community philosophy, our communit
9696

9797
### Contributor
9898

99-
- Set up a development platform account:
100-
- Create a Jira account: [https://issues.apache.org/jira/projects/IOTDB/issues](https://issues.apache.org/jira/projects/IOTDB/issues) to claim an issue.
101-
- 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.
102-
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.
103-
- Long Term Matters:
104-
- Learn how to debug IoTDB
105-
- [How to debug IoTDB server](https://my.oschina.net/u/3664598/blog/4500279)
106-
- Understand the basics of using IoTDB
107-
- [IoTDB download and installation](../UserGuide/latest/Deployment-and-Maintenance/IoTDB-Package_apache.md)
108-
- [IoTDB Quick Start Guide](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart_apache.html)
109-
- [Data Schema and Concepts](https://iotdb.apache.org/UserGuide/latest/Basic-Concept/Data-Model-and-Terminology.html)
110-
- [API Interface](https://iotdb.apache.org/UserGuide/latest/API/Programming-Java-Native-API.html)
111-
- Understand IoTDB's Internal Design
112-
- [IoTDB Design Documentation](https://cwiki.apache.org/confluence/display/IOTDB/Home)
113-
- Finding tasks to be done
114-
- [Resolving Issues on Jira](https://issues.apache.org/jira/projects/IOTDB/issues)
99+
Becoming a Contributor requires no election: anyone who makes a valid contribution to the project is a Contributor. The following is a recommended path to start contributing to IoTDB from scratch.
100+
101+
#### Step 1: Join the community discussion
102+
103+
- Subscribe to the developer mailing list <dev@iotdb.apache.org>. The mailing list is the official communication channel of the Apache community, where development plans, technical discussions, and requests for help all take place. See [Communication Channels](https://iotdb.apache.org/Community/Communication-Channels.html) for how to subscribe.
104+
- When participating for the first time, feel free to send an email to introduce yourself. If you run into any problems during development, you can start a discussion on the mailing list.
105+
106+
#### Step 2: Get the code running
107+
108+
- To clone the source, build from source, and start and debug IoTDB in an IDE, refer to the documentation in the code repository:
109+
- [Apache IoTDB README](https://github.com/apache/iotdb/blob/master/README.md) (environment requirements, building, and starting DataNode/CLI with breakpoint debugging in IDEA)
110+
- [Development Guide](https://iotdb.apache.org/Community/Development-Guide.html) (contribution workflow, code formatting, PR conventions, etc.)
111+
- To get familiar with IoTDB as a user first, see:
112+
- [IoTDB download and installation](https://iotdb.apache.org/UserGuide/latest/Deployment-and-Maintenance/IoTDB-Package_apache.html)
113+
- [IoTDB Quick Start Guide](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart_apache.html)
114+
- [Data Schema and Concepts](https://iotdb.apache.org/UserGuide/latest/Basic-Concept/Data-Model-and-Terminology.html)
115+
- [Java Native API](https://iotdb.apache.org/UserGuide/latest/API/Programming-Java-Native-API.html)
116+
117+
#### Step 3: Understand the internal design
118+
119+
- The design and implementation of IoTDB mainly live in the source code; reading it together with the [README](https://github.com/apache/iotdb/blob/master/README.md) is recommended.
120+
- If you have questions about the design, feel free to raise them on the mailing list <dev@iotdb.apache.org>, where community members will join the discussion.
121+
122+
#### Step 4: Pick a task and start contributing
123+
124+
- You can look for tasks that interest you on [GitHub Issues](https://github.com/apache/iotdb/issues) or [Jira](https://issues.apache.org/jira/projects/IOTDB/issues), or describe what you would like to work on via the mailing list. Newcomers are encouraged to start with issues labeled newbie / good first issue.
125+
- For the full contribution workflow (submit a PR → review → merge), see the [Development Guide](https://iotdb.apache.org/Community/Development-Guide.html).
126+
- If you run into problems, feel free to ask via the mailing list or the channels listed in [Communication Channels](https://iotdb.apache.org/Community/Communication-Channels.html).
115127

116128
## Code of Conduct in the Apache Community
117129

src/zh/Community/About.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -100,22 +100,34 @@
100100

101101
### Contributor
102102

103-
- 创建开发平台账号:
104-
- 创建 Jira 账号:[https://issues.apache.org/jira/projects/IOTDB/issues](https://issues.apache.org/jira/projects/IOTDB/issues) ,用来认领 issue。
105-
- 创建 Confluence 账号:[https://cwiki.apache.org/confluence/display/IOTDB/Home](https://cwiki.apache.org/confluence/display/IOTDB/Home) ,之后用来写设计文档。
106-
创建好后,向邮件列表发送一封邮件,包括 **自我介绍** 以及 **Jira ID****Confluence ID**,社区 PMC 会为账户添加权限。
107-
- 长期事项:
108-
- 学习如何调试 IoTDB
109-
- [如何调试 IoTDB server](https://my.oschina.net/u/3664598/blog/4500279)
110-
- 学习 IoTDB 的基本使用
111-
- [IoTDB 下载与安装](../UserGuide/latest/Deployment-and-Maintenance/IoTDB-Package_apache.md)
112-
- [IoTDB 快速上手](https://iotdb.apache.org/zh/UserGuide/Master/QuickStart/QuickStart.html)
113-
- [数据模式与概念](https://iotdb.apache.org/zh/UserGuide/latest/Basic-Concept/Data-Model-and-Terminology.html)
114-
- [API 接口](https://iotdb.apache.org/zh/UserGuide/latest/API/Programming-Java-Native-API.html)
115-
- 了解 IoTDB 的内部设计
116-
- [IoTDB 设计文档](https://cwiki.apache.org/confluence/display/IOTDB/Home)
117-
- 寻找待做任务
118-
- [在 Jira 上解决 issue](https://issues.apache.org/jira/projects/IOTDB/issues)
103+
成为 Contributor 不需要评选,任何向项目提交了有效贡献的人都是 Contributor。下面是从零开始参与 IoTDB 开发的推荐路径。
104+
105+
#### 第一步:加入社区交流
106+
107+
- 订阅开发者邮件列表 <dev@iotdb.apache.org>。邮件列表是 Apache 社区官方指定的交流渠道,开发计划、技术讨论、问题求助都在这里进行,订阅方式见[交流与反馈](https://iotdb.apache.org/zh/Community/Feedback.html)
108+
- 第一次参与时,欢迎发一封邮件做个自我介绍。开发过程中遇到任何问题,都可以在邮件列表中发起讨论。
109+
110+
#### 第二步:把代码跑起来
111+
112+
- 拉取源码、从源码编译、在 IDE 中启动并调试 IoTDB,请参考代码仓库的说明文档:
113+
- [Apache IoTDB README](https://github.com/apache/iotdb/blob/master/README.md)(环境要求、编译,以及在 IDEA 中启动 DataNode/CLI、设置断点调试)
114+
- [贡献指南](https://iotdb.apache.org/zh/Community/Development-Guide.html)(贡献流程、代码格式化、PR 规范等)
115+
- 想先以普通用户身份了解 IoTDB,可参考:
116+
- [IoTDB 下载与安装](https://iotdb.apache.org/zh/UserGuide/latest/Deployment-and-Maintenance/IoTDB-Package_apache.html)
117+
- [IoTDB 快速上手](https://iotdb.apache.org/zh/UserGuide/latest/QuickStart/QuickStart.html)
118+
- [数据模型与概念](https://iotdb.apache.org/zh/UserGuide/latest/Basic-Concept/Data-Model-and-Terminology.html)
119+
- [Java 原生 API](https://iotdb.apache.org/zh/UserGuide/latest/API/Programming-Java-Native-API.html)
120+
121+
#### 第三步:了解内部设计
122+
123+
- IoTDB 的设计与实现主要体现在源码中,建议结合 [README](https://github.com/apache/iotdb/blob/master/README.md) 和源码阅读。
124+
- 对设计有疑问时,欢迎在邮件列表 <dev@iotdb.apache.org> 中提出,社区成员会参与讨论。
125+
126+
#### 第四步:找一个任务并开始贡献
127+
128+
- 你可以在 [GitHub Issues](https://github.com/apache/iotdb/issues)[Jira](https://issues.apache.org/jira/projects/IOTDB/issues) 上寻找感兴趣的任务,也可以在邮件列表中说明你想做的方向。新手建议从标记为新手友好(newbie / good first issue)的任务入手。
129+
- 完整的贡献流程(提交 PR → 审阅 → 合并)请见[贡献指南](https://iotdb.apache.org/zh/Community/Development-Guide.html)
130+
- 遇到问题,欢迎随时通过[交流与反馈](https://iotdb.apache.org/zh/Community/Feedback.html)中的邮件列表、微信群或 QQ 群提问。
119131

120132
## 社区公约
121133

src/zh/Community/Feedback.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,9 @@ Github Issue 链接:<https://github.com/apache/iotdb/issues>
4848
## 途径四:通过微信群、QQ 群等方式进行交流
4949

5050
- 入群方式:
51-
- 微信群——添加好友:apache_iotdb
51+
- 微信群——添加好友apache_iotdb
5252
- QQ 群——659990460
53-
- 钉钉群:搜索群名称加入【Apache IoTDB 交流 1 群】
54-
- 微信公众号:IoTDB 漫游指南
53+
- 微信公众号:Apache IoTDB(微信号:Apache-IoTDB)
5554
- 我们非常期待您分享您使用 IoTDB 的经验:[调研问卷](https://github.com/apache/iotdb/issues/748)
5655

5756
## 途径五:通过 Slack 进行交流(全英文)

0 commit comments

Comments
 (0)