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 2021/05/15 10:14:20 UTC
[iotdb] branch master updated: Update some out-of-date contents in
README and ContributeGuide (#3196)
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 49f8919 Update some out-of-date contents in README and ContributeGuide (#3196)
49f8919 is described below
commit 49f89192dd4cbe09718491c9dc02fae09de7d4a6
Author: Haonan <hh...@outlook.com>
AuthorDate: Sat May 15 18:13:52 2021 +0800
Update some out-of-date contents in README and ContributeGuide (#3196)
---
.../ContributeGuide.md => CONTRIBUTING.md | 63 ++++++++++++----------
README.md | 19 +++----
README_ZH.md | 13 ++---
docs/Development/ContributeGuide.md | 62 +++++++++++----------
docs/zh/Development/ContributeGuide.md | 26 ++++-----
5 files changed, 101 insertions(+), 82 deletions(-)
diff --git a/docs/Development/ContributeGuide.md b/CONTRIBUTING.md
similarity index 74%
copy from docs/Development/ContributeGuide.md
copy to CONTRIBUTING.md
index 3dea6c0..469bb1e 100644
--- a/docs/Development/ContributeGuide.md
+++ b/CONTRIBUTING.md
@@ -19,7 +19,7 @@
-->
-# 1. work process
+# IoTDB Working Process
## Main link
@@ -47,17 +47,17 @@ Other mailing list:
-## New features, bug feedback, improvements, and more
+## New features, bug feedback, improvements and more
All features or bugs that you want IoTDB to do can be raised on Jira：https://issues.apache.org/jira/projects/IOTDB/issues
-You can choose issue types: bug, improvement, new feature, etc. New issues will be automatically synchronized to the mailing list (notifications@), and subsequent discussions can be left on jira or on the mailing list. When the issue is resolved, close the issue.
+You can choose issue types: bug, improvement, new feature, etc. New issues will be automatically synchronized to the mailing list (notifications@), and subsequent discussions can be left on jira or on the mailing list. When the issue is resolved, close the issue.
## Email discussion content (English)
-* Joining the mailing list for the first time can introduce you briefly. (Hi, I'm xxx ...)
+* Joining the mailing list for the first time can introduce youself briefly. (Hi, I'm xxx ...)
-* Before developing a function, you can send an e-mail to declare the task you want to do.（Hi，I'm working on issue IOTDB-XXX，My plan is ...）
+* Before developing a new feature, you can send an e-mail to declare the task you want to do.（Hi，I'm working on issue IOTDB-XXX，My plan is ...）
## Contributing documents
@@ -75,15 +75,15 @@ The content of all IoTDB official websites is in the docs of the project root di
Correspondence between versions and branches on the official website:
* In progress -> master
-* major_version.x -> rel/major_version （如 0.9.x -> rel/0.9）
+* major_version.x -> rel/major_version （eg 0.9.x -> rel/0.9）
Precautions:
-* Images in Markdown can be uploaded to https://github.com/thulab/iotdb/issues/543 for url
+* Images in Markdown can be uploaded to https://github.com/apache/iotdb-bin-resources for url
* Do not use special Unicode chars, e.g., U+FF1A
* Do not use the character of dollar (as we will use Latex to generate pdf files)
-### Code Formatting
+## Code Formatting
We use the [Spotless
plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) together with [google-java-format](https://github.com/google/google-java-format) to format our Java code. You can configure your IDE to automatically apply formatting on saving with these steps(Take idea as an example):
@@ -123,31 +123,40 @@ You can go to jira to pick up the existing issue or create your own issue and ge
* Make changes based on other people's reviews and continue to update until merged
* close jira issue
-## 2. IoTDB debugging method
+# IoTDB Debug Guide
-Recommended Use Intellij idea. ```mvn clean package -DskipTests``` After putting ```antlr/target/generated-sources/antlr4``` and ```thrift/target/generated-sources/thrift``` marked as ```Source Root```。
+Recommended use Intellij idea.
+```
+mvn clean package -DskipTests
+```
+
+Mark `antlr/target/generated-sources/antlr4` and `thrift/target/generated-sources/thrift` as `Source Root`.
+
+* Server main function：`server/src/main/java/org/apache/iotdb/db/service/IoTDB`, can be started in debug mode.
+* Cli：`cli/src/main/java/org/apache/iotdb/cli/`，Use Cli for linux and WinCli for windows, you can start directly with the parameter "`-h 127.0.0.1 -p 6667 -u root -pw root`"
+* Server rpc implementation (mainly used for cli and server communication, generally start interruption point here):`server/src/main/java/org/apache/iotdb/db/service/TSServiceImpl`
+* all jdbc statements：`executeStatement(TSExecuteStatementReq req)`
+* jdbc query：`executeQueryStatement(TSExecuteStatementReq req)`
+* native Write interface：`insertRecord(TSInsertRecordReq req)`
+`insertTablet(TSInsertTabletReq req)`
+
+* Storage engine`org.apache.iotdb.db.engine.StorageEngine`
+* Query engine `org.apache.iotdb.db.qp.QueryProcessor`
-* Server main function：```server/src/main/java/org/apache/iotdb/db/service/IoTDB``, Can be started in debug mode
-* Cli：```cli/src/main/java/org/apache/iotdb/cli/```，Use Cli for linux and WinCli for windows, you can start directly with the parameter "-h 127.0.0.1 -p 6667 -u root -pw root"
-* Server rpc implementation (mainly used for cli and server communication, generally start interruption point here):```server/src/main/java/org/apache/iotdb/db/service/TSServiceImpl```
- * all jdbc statements：executeStatement(TSExecuteStatementReq req)
- * jdbc query：executeQueryStatement(TSExecuteStatementReq req)
- * native Write interface：insertRecord(TSInsertRecordReq req)
-* Storage engine org.apache.iotdb.db.engine.StorageEngine
-* Query engine org.apache.iotdb.db.qp.QueryProcessor
+# Frequent Questions When Compiling the Source Code
+I could not download thrift-* tools, like `Could not get content
+org.apache.maven.wagon.TransferFailedException: Transfer failed for https://github.com/apache/iotdb-bin-resources/blob/main/compile-tools/thrift-0.14-ubuntu`
-## Frequent Questions when Compiling the Source Code
+ It is due to some network problems (especially in China), you can:
-1. I could not download thrift-* tools, like `Could not get content
-org.apache.maven.wagon.TransferFailedException: Transfer failed for https://github.com/jt2594838/mvn-thrift-compiler/raw/master/thrift_0.12.0_0.13.0_linux.exe`
+ * Download the file from the URL manually;
+ * https://github.com/apache/iotdb-bin-resources/blob/main/compile-tools/thrift-0.14-ubuntu
-It is due to some network problems (especially in China), you can:
+ * https://github.com/apache/iotdb-bin-resources/blob/main/compile-tools/thrift-0.14-MacOS
+
+ * Put the file to thrift/target/tools/
-* Download the file from the URL manually;
- * https://github.com/jt2594838/mvn-thrift-compiler/blob/master/thrift_0.12.0_0.13.0_mac.exe
- * https://github.com/jt2594838/mvn-thrift-compiler/raw/master/thrift_0.12.0_0.13.0_mac.exe
-* Put the file to thrift/target/tools/
-* Re-run maven command like `mvn compile`
+ * Re-run maven command like `mvn compile`
diff --git a/README.md b/README.md
index 57dd722..fef9265 100644
--- a/README.md
+++ b/README.md
@@ -86,7 +86,7 @@ This short guide will walk you through the basic process of using IoTDB. For a m
To use IoTDB, you need to have:
-1. Java >= 1.8 (1.8, 11, and 13 are verified. Please make sure the environment path has been set accordingly).
+1. Java >= 1.8 (1.8, 11, and 15 are verified. Please make sure the environment path has been set accordingly).
2. Maven >= 3.6 (If you want to compile and install IoTDB from source code).
3. Set the max open files num as 65535 to avoid "too many open files" error.
@@ -99,7 +99,7 @@ IoTDB provides three installation methods, you can refer to the following sugges
* Using Docker：The path to the dockerfile is https://github.com/apache/iotdb/tree/master/docker/src/main
-Here in the Quick Start, we give a brief introduction of using source code to install IoTDB. For further information, please refer to Chapter 3 of the User Guide.
+Here in the Quick Start, we give a brief introduction of using source code to install IoTDB. For further information, please refer to [User Guide](https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html).
## Build from source
@@ -137,7 +137,7 @@ You can download the source code from:
git clone https://github.com/apache/iotdb.git
```
-The default master branch is the dev branch, If you want to use a released version x.x.x:
+The default dev branch is the master branch, If you want to use a released version x.x.x:
```
git checkout release/x.x.x
@@ -159,11 +159,12 @@ Using `-P compile-cpp` for compiling cpp client (For more details, read client-c
Then the binary version (including both server and cli) can be found at **distribution/target/apache-iotdb-{project.version}-all-bin.zip**
-NOTE: Directories `thrift/target/generated-sources/thrift`, `thrift-sync/target/generated-sources/thrift`,
-`thrift-cluster/target/generated-sources/thrift`
-and `antlr/target/generated-sources/antlr4` need to be added to sources roots to avoid compilation errors in the IDE.
-In IDEAJ, you just need to right click on the root project name and choose "Maven->Reload Project" after
-you run `mvn package` successfully.
+**NOTE: Directories "`thrift/target/generated-sources/thrift`", "`thrift-sync/target/generated-sources/thrift`",
+"`thrift-cluster/target/generated-sources/thrift`"
+and "`antlr/target/generated-sources/antlr4`" need to be added to sources roots to avoid compilation errors in the IDE.**
+
+**In IDEA, you just need to right click on the root project name and choose "`Maven->Reload Project`" after
+you run `mvn package` successfully.**
### Configurations
@@ -173,7 +174,7 @@ configuration files are under "conf" folder
* system config module (`iotdb-engine.properties`)
* log config module (`logback.xml`).
-For more information, please see [Chapter3: Server](http://iotdb.apache.org/UserGuide/Master/Server/Config%20Manual.html).
+For more information, please see [Config Manual](https://iotdb.apache.org/UserGuide/Master/Appendix/Config-Manual.html).
## Start
diff --git a/README_ZH.md b/README_ZH.md
index 03bca8e..5f7b331 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -83,7 +83,7 @@ IoTDB的主要特点如下:
## 环境准备
要使用IoTDB，您需要:
-1. Java >= 1.8 (目前 1.8、11和13 已经被验证可用。请确保环变量境路径已正确设置)。
+1. Java >= 1.8 (目前 1.8、11和15 已经被验证可用。请确保环变量境路径已正确设置)。
2. Maven >= 3.6 (如果希望从源代码编译和安装IoTDB)。
3. 设置 max open files 为 65535，以避免"too many open files"错误。
@@ -97,7 +97,7 @@ IoTDB提供了三种安装方法，您可以参考以下建议，选择最适合
* 使用Docker: dockerfile的路径是https://github.com/apache/iotdb/tree/master/docker/src/main
-在这篇《快速入门》中，我们简要介绍如何使用源代码安装IoTDB。如需进一步资料，请参阅《用户指南》第3章。
+在这篇《快速入门》中，我们简要介绍如何使用源代码安装IoTDB。如需进一步资料，请参阅官网[用户指南](http://iotdb.apache.org/zh/UserGuide/Master/Get%20Started/QuickStart.html)。
## 从源码构建
@@ -127,7 +127,7 @@ Thrift官方网址为：https://thrift.apache.org/
git clone https://github.com/apache/iotdb.git
```
-默认的主分支是dev分支，如果你想使用某个发布版本x.x.x，请切换分支:
+默认的主分支是master分支，如果你想使用某个发布版本x.x.x，请切换分支:
```
git checkout release/x.x.x
@@ -148,8 +148,9 @@ git checkout vx.x.x
执行完成之后，可以在**distribution/target/apache-iotdb-{project.version}-all-bin.zip**找到编译完成的二进制版本(包括服务器和客户端)
-> 注意:"thrift/target/generated-sources/thrift" 和 "antlr/target/generated-sources/antlr4" 目录需要添加到源代码根中，以免在 IDE 中产生编译错误。
-> IDEA的操作方法：在上述maven命令编译好后，右键项目名称，选择"Maven->Reload project"，即可。
+**注意："`thrift/target/generated-sources/thrift`"， "`thrift-sync/target/generated-sources/thrift`"，"`thrift/target/generated-sources/thrift`" 和 "`antlr/target/generated-sources/antlr4`" 目录需要添加到源代码根中，以免在 IDE 中产生编译错误。**
+
+**IDEA的操作方法：在上述maven命令编译好后，右键项目名称，选择"`Maven->Reload project`"，即可。**
### 配置
@@ -158,7 +159,7 @@ git checkout vx.x.x
* 系统配置模块(`iotdb-engine.properties`)
* 日志配置模块(`logback.xml`)。
-有关详细信息，请参见[Chapter3: Server](http://iotdb.apache.org/zh/UserGuide/Master/Server/Config%20Manual.html)。
+有关详细信息，请参见[配置参数](https://iotdb.apache.org/zh/UserGuide/Master/Appendix/Config-Manual.html)。
## 开始
diff --git a/docs/Development/ContributeGuide.md b/docs/Development/ContributeGuide.md
index 3dea6c0..fd4a5ce 100644
--- a/docs/Development/ContributeGuide.md
+++ b/docs/Development/ContributeGuide.md
@@ -19,7 +19,7 @@
-->
-# 1. work process
+# IoTDB Working Process
## Main link
@@ -47,17 +47,17 @@ Other mailing list:
-## New features, bug feedback, improvements, and more
+## New features, bug feedback, improvements and more
All features or bugs that you want IoTDB to do can be raised on Jira：https://issues.apache.org/jira/projects/IOTDB/issues
-You can choose issue types: bug, improvement, new feature, etc. New issues will be automatically synchronized to the mailing list (notifications@), and subsequent discussions can be left on jira or on the mailing list. When the issue is resolved, close the issue.
+You can choose issue types: bug, improvement, new feature, etc. New issues will be automatically synchronized to the mailing list (notifications@), and subsequent discussions can be left on jira or on the mailing list. When the issue is resolved, close the issue.
## Email discussion content (English)
-* Joining the mailing list for the first time can introduce you briefly. (Hi, I'm xxx ...)
+* Joining the mailing list for the first time can introduce youself briefly. (Hi, I'm xxx ...)
-* Before developing a function, you can send an e-mail to declare the task you want to do.（Hi，I'm working on issue IOTDB-XXX，My plan is ...）
+* Before developing a new feature, you can send an e-mail to declare the task you want to do.（Hi，I'm working on issue IOTDB-XXX，My plan is ...）
## Contributing documents
@@ -75,15 +75,15 @@ The content of all IoTDB official websites is in the docs of the project root di
Correspondence between versions and branches on the official website:
* In progress -> master
-* major_version.x -> rel/major_version （如 0.9.x -> rel/0.9）
+* major_version.x -> rel/major_version （eg 0.9.x -> rel/0.9）
Precautions:
-* Images in Markdown can be uploaded to https://github.com/thulab/iotdb/issues/543 for url
+* Images in Markdown can be uploaded to https://github.com/apache/iotdb-bin-resources for url
* Do not use special Unicode chars, e.g., U+FF1A
* Do not use the character of dollar (as we will use Latex to generate pdf files)
-### Code Formatting
+## Code Formatting
We use the [Spotless
plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) together with [google-java-format](https://github.com/google/google-java-format) to format our Java code. You can configure your IDE to automatically apply formatting on saving with these steps(Take idea as an example):
@@ -123,31 +123,39 @@ You can go to jira to pick up the existing issue or create your own issue and ge
* Make changes based on other people's reviews and continue to update until merged
* close jira issue
-## 2. IoTDB debugging method
+# IoTDB Debug Guide
-Recommended Use Intellij idea. ```mvn clean package -DskipTests``` After putting ```antlr/target/generated-sources/antlr4``` and ```thrift/target/generated-sources/thrift``` marked as ```Source Root```。
+Recommended use Intellij idea.
+```
+mvn clean package -DskipTests
+```
+
+Mark `antlr/target/generated-sources/antlr4` and `thrift/target/generated-sources/thrift` as `Source Root`.
+
+* Server main function：`server/src/main/java/org/apache/iotdb/db/service/IoTDB`, can be started in debug mode.
+* Cli：`cli/src/main/java/org/apache/iotdb/cli/`，Use Cli for linux and WinCli for windows, you can start directly with the parameter "`-h 127.0.0.1 -p 6667 -u root -pw root`"
+* Server rpc implementation (mainly used for cli and server communication, generally start interruption point here):`server/src/main/java/org/apache/iotdb/db/service/TSServiceImpl`
+* all jdbc statements：`executeStatement(TSExecuteStatementReq req)`
+* jdbc query：`executeQueryStatement(TSExecuteStatementReq req)`
+* native Write interface：`insertRecord(TSInsertRecordReq req)`
+`insertTablet(TSInsertTabletReq req)`
-* Server main function：```server/src/main/java/org/apache/iotdb/db/service/IoTDB``, Can be started in debug mode
-* Cli：```cli/src/main/java/org/apache/iotdb/cli/```，Use Cli for linux and WinCli for windows, you can start directly with the parameter "-h 127.0.0.1 -p 6667 -u root -pw root"
-* Server rpc implementation (mainly used for cli and server communication, generally start interruption point here):```server/src/main/java/org/apache/iotdb/db/service/TSServiceImpl```
- * all jdbc statements：executeStatement(TSExecuteStatementReq req)
- * jdbc query：executeQueryStatement(TSExecuteStatementReq req)
- * native Write interface：insertRecord(TSInsertRecordReq req)
+* Storage engine`org.apache.iotdb.db.engine.StorageEngine`
+* Query engine `org.apache.iotdb.db.qp.QueryProcessor`
-* Storage engine org.apache.iotdb.db.engine.StorageEngine
-* Query engine org.apache.iotdb.db.qp.QueryProcessor
+# Frequent Questions When Compiling the Source Code
-## Frequent Questions when Compiling the Source Code
+I could not download thrift-* tools, like `Could not get content
+org.apache.maven.wagon.TransferFailedException: Transfer failed for https://github.com/apache/iotdb-bin-resources/blob/main/compile-tools/thrift-0.14-ubuntu`
-1. I could not download thrift-* tools, like `Could not get content
-org.apache.maven.wagon.TransferFailedException: Transfer failed for https://github.com/jt2594838/mvn-thrift-compiler/raw/master/thrift_0.12.0_0.13.0_linux.exe`
+ It is due to some network problems (especially in China), you can:
-It is due to some network problems (especially in China), you can:
+ * Download the file from the URL manually;
+ * https://github.com/apache/iotdb-bin-resources/blob/main/compile-tools/thrift-0.14-ubuntu
-* Download the file from the URL manually;
- * https://github.com/jt2594838/mvn-thrift-compiler/blob/master/thrift_0.12.0_0.13.0_mac.exe
- * https://github.com/jt2594838/mvn-thrift-compiler/raw/master/thrift_0.12.0_0.13.0_mac.exe
-* Put the file to thrift/target/tools/
-* Re-run maven command like `mvn compile`
+ * https://github.com/apache/iotdb-bin-resources/blob/main/compile-tools/thrift-0.14-MacOS
+
+ * Put the file to thrift/target/tools/
+ * Re-run maven command like `mvn compile`
\ No newline at end of file
diff --git a/docs/zh/Development/ContributeGuide.md b/docs/zh/Development/ContributeGuide.md
index 930b3d8..98e93a0 100644
--- a/docs/zh/Development/ContributeGuide.md
+++ b/docs/zh/Development/ContributeGuide.md
@@ -19,7 +19,7 @@
-->
-# 一、工作流程
+# 工作流程
## 主要链接
@@ -47,7 +47,7 @@ Wiki 文档管理：https://cwiki.apache.org/confluence/display/IOTDB/Home
* commits@iotdb.apache.org (任何代码改动都会通知到此处。该邮件列表邮件数量十分多，请注意。)
* reviews@iotdb.apache.org (任何代码审阅意见都会通知到此处。该邮件列表邮件数量十分多，请注意。)
-## 新功能、Bug 反馈、改进等
+## 新功能、Bug反馈、改进等
所有希望 IoTDB 做的功能或修的 bug，都可以在 Jira 上提 issue
@@ -79,7 +79,7 @@ IoTDB 所有官网上的内容都在项目根目录的 docs 中：
注意事项：
-* Markdown 中的图片可上传至 https://github.com/thulab/iotdb/issues/543 获得 url
+* Markdown 中的图片可上传至 https://github.com/apache/iotdb-bin-resources 获得 url
## 代码格式化
@@ -108,7 +108,7 @@ plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) 和 [google
* 根据其他人的审阅意见进行修改，继续更新，直到合并
* 关闭 jira issue
-# 二、IoTDB 调试方式
+# IoTDB调试方式
## 导入代码
@@ -142,16 +142,16 @@ import -> Maven -> Existing Maven Projects
-## 常见编译错误
-
-1. 无法下载 thrift-* 等文件, 例如 `Could not get content
-org.apache.maven.wagon.TransferFailedException: Transfer failed for https://github.com/jt2594838/mvn-thrift-compiler/raw/master/thrift_0.12.0_0.13.0_linux.exe`
+# 常见编译错误
+无法下载 thrift-* 等文件, 例如 `Could not get content
+org.apache.maven.wagon.TransferFailedException: Transfer failed for https://github.com/apache/iotdb-bin-resources/blob/main/compile-tools/thrift-0.14-ubuntu`
这一般是网络问题，这时候需要手动下载上述文件：
-* 根据以下网址手动下载上述文件;
- * https://github.com/jt2594838/mvn-thrift-compiler/blob/master/thrift_0.12.0_0.13.0_mac.exe
- * https://github.com/jt2594838/mvn-thrift-compiler/raw/master/thrift_0.12.0_0.13.0_mac.exe
-* 将该文件拷贝到thrift/target/tools/目录下
-* 重新执行maven的编译命令
+ * 根据以下网址手动下载上述文件;
+ * https://github.com/apache/iotdb-bin-resources/blob/main/compile-tools/thrift-0.14-MacOS
+ * https://github.com/apache/iotdb-bin-resources/blob/main/compile-tools/thrift-0.14-ubuntu
+
+ * 将该文件拷贝到thrift/target/tools/目录下
+ * 重新执行maven的编译命令