You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ha...@apache.org on 2022/05/10 04:31:12 UTC
[iotdb] branch master updated: Doc file update (#5027)
This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new d6f43bc866 Doc file update (#5027)
d6f43bc866 is described below
commit d6f43bc866f723c7cf33582aa3060464df54597c
Author: Zhang Zeyu <Je...@outlook.com>
AuthorDate: Tue May 10 12:31:07 2022 +0800
Doc file update (#5027)
Co-authored-by: Haonan <hh...@outlook.com>
---
docs/Development/HowToJoin.md | 65 +++++++++++++++++++++++++++++++++++++++
docs/zh/Development/HowToJoin.md | 65 +++++++++++++++++++++++++++++++++++++++
site/src/main/.vuepress/config.js | 2 ++
3 files changed, 132 insertions(+)
diff --git a/docs/Development/HowToJoin.md b/docs/Development/HowToJoin.md
new file mode 100644
index 0000000000..e0a1df7cd7
--- /dev/null
+++ b/docs/Development/HowToJoin.md
@@ -0,0 +1,65 @@
+<!--
+
+ 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.
+
+-->
+
+# IoTDB Contributor Beginning
+## Subscribe to the mailing list (dev@iotdb.apache.org)
+The mailing list is the only communication channel that Apache designates for open source contributors. So try to make discussions on the mailing list as much as possible. The mailing list is essentially a mailbox. After subscription, all emails sent to this mailbox will be forwarded to the subscribed mailbox. The subscription method is as follows:
+
+ 1. Sending subscription email: Send an email to [dev-subscribe@iotdb.apache.org](dev-subscribe@iotdb.apache.org) with any subject you want.
+ 2. Confirming subscription: You will receive a subscription confirmation email from iotdb.apache.org after completing the previous step. Confirm your subscription by sending another email to this email with any subject matter.
+
+## Create a development platform account
+
+ 1. Creating Jira account: [https://issues.apache.org/jira/projects/IOTDB/issues](https://issues.apache.org/jira/projects/IOTDB/issues) in order to claim issues.
+ 2. Creating Confluence account: [https://cwiki.apache.org/confluence/display/IOTDB/Home](https://cwiki.apache.org/confluence/display/IOTDB/Home) . It is then used to write design documents.
+
+After creation, please send an email to the mailing list including **self introduction**, **Jira ID** and **Confluence ID**. The community PMC will add permissions to the account.
+
+## Enter user/development chat group
+
+ - QQ user group: 659990460
+ - WeChat user group: IoTDB 数据库交流x群
+ - Slack: [Apache IoTDB Community](https://join.slack.com/t/apacheiotdb/shared_invite/zt-qvso1nj8-7715TpySZtZqmyG5qXQwpg)
+
+## Subscribe WeChat public account
+Scan the QR code to subscribe official public account: Apache IoTDB
+
+
+## Long term considerations
+### Learn the basic use of IoTDB
+
+ - [Download and Setup](https://iotdb.apache.org/UserGuide/Master/QuickStart/WayToGetIoTDB.html)
+ - [IoTDB Quick Start](https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html)
+ - [Data Concept](https://iotdb.apache.org/UserGuide/Master/Data-Concept/Data-Model-and-Terminology.html)
+ - [API](https://iotdb.apache.org/UserGuide/Master/API/Programming-Java-Native-API.html)
+
+### Learn to debug IoTDB
+
+ - [How to debug IoTDB server](https://my.oschina.net/u/3664598/blog/4500279)
+
+### Understand the internal design of IoTDB
+
+ - [IoTDB design documentation](https://cwiki.apache.org/confluence/display/IOTDB/Home)
+
+### Find to-do tasks
+
+ - [Resolve issues on Jira](https://issues.apache.org/jira/projects/IOTDB/issues)
+
diff --git a/docs/zh/Development/HowToJoin.md b/docs/zh/Development/HowToJoin.md
new file mode 100644
index 0000000000..f75a437450
--- /dev/null
+++ b/docs/zh/Development/HowToJoin.md
@@ -0,0 +1,65 @@
+<!--
+
+ 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.
+
+-->
+
+# IoTDB Contributor 入门步骤
+## 订阅邮件列表 (dev@iotdb.apache.org)
+邮件列表是 Apache 唯一指定的贡献者交流渠道，所有设计和讨论尽量都在邮件列表里进行。邮件列表本质是一个邮箱，订阅之后，所有发往这个邮箱的邮件，都会转发到订阅的邮箱中，订阅方式如下：
+
+ 1. 发送订阅邮件：向 [dev-subscribe@iotdb.apache.org](dev-subscribe@iotdb.apache.org) 发送一封邮件，主题内容不限。
+ 2. 确认订阅邮件：完成上一步后，将收到一封来自 iotdb.apache.org 结尾的确认订阅邮件。向该邮件再次发一封主题内容不限的邮件即可确认订阅。
+
+## 创建开发平台账号
+
+ 1. 创建 Jira 账号：[https://issues.apache.org/jira/projects/IOTDB/issues](https://issues.apache.org/jira/projects/IOTDB/issues) ，用来认领 issue。
+ 2. 创建 Confluence 账号：[https://cwiki.apache.org/confluence/display/IOTDB/Home](https://cwiki.apache.org/confluence/display/IOTDB/Home) ，之后用来写设计文档。
+
+创建好后，向邮件列表发送一封邮件，包括 **自我介绍** 以及 **Jira ID** 和 **Confluence ID**，社区PMC会为账户添加权限。
+
+## 进用户/开发群
+
+ - QQ用户群：659990460
+ - 微信用户群：IoTDB 数据库交流x群
+ - Slack：[Apache IoTDB Community](https://join.slack.com/t/apacheiotdb/shared_invite/zt-qvso1nj8-7715TpySZtZqmyG5qXQwpg)
+
+## 关注公众号
+扫码关注官方公众号：Apache IoTDB
+
+
+## 长期事项
+### 学习IoTDB的基本使用
+
+ - [IoTDB下载与安装](https://iotdb.apache.org/zh/UserGuide/Master/QuickStart/WayToGetIoTDB.html)
+ - [IoTDB快速上手](https://iotdb.apache.org/zh/UserGuide/Master/QuickStart/QuickStart.html)
+ - [数据模式与概念](https://iotdb.apache.org/zh/UserGuide/Master/Data-Concept/Data-Model-and-Terminology.html)
+ - [API接口](https://iotdb.apache.org/zh/UserGuide/Master/API/Programming-Java-Native-API.html)
+
+### 学习如何调试IoTDB
+
+ - [如何调试 IoTDB server](https://my.oschina.net/u/3664598/blog/4500279)
+
+### 了解IoTDB的内部设计
+
+ - [IoTDB设计文档](https://cwiki.apache.org/confluence/display/IOTDB/Home)
+
+### 寻找待做任务
+
+ - [在Jira上解决issue](https://issues.apache.org/jira/projects/IOTDB/issues)
+
diff --git a/site/src/main/.vuepress/config.js b/site/src/main/.vuepress/config.js
index e6f51fe163..4712f29663 100644
--- a/site/src/main/.vuepress/config.js
+++ b/site/src/main/.vuepress/config.js
@@ -117,6 +117,7 @@ var config = {
items: [
{ text: 'How to vote', link: '/Development/VoteRelease'},
{ text: 'How to Commit', link: '/Development/HowToCommit'},
+ { text: 'Become a Contributor', link: '/Development/HowToJoin'}
{ text: 'Become a Committer', link: '/Development/Committer'},
{ text: 'ContributeGuide', link: '/Development/ContributeGuide'},
{ text: 'Changelist of TsFile', link: '/Development/format-changelist'},
@@ -1056,6 +1057,7 @@ var config = {
items: [
{ text: '如何投票', link: '/zh/Development/VoteRelease'},
{ text: '如何提交代码', link: '/zh/Development/HowToCommit'},
+ { text: '成为Contributor', link: '/zh/Development/HowToJoin'}
{ text: '成为Committer', link: '/zh/Development/Committer'},
{ text: '项目开发指南', link: '/zh/Development/ContributeGuide'},
{ text: 'TsFile的更改列表', link: '/zh/Development/format-changelist'},