You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by xi...@apache.org on 2022/12/16 10:27:26 UTC
[iotdb] branch master updated: Remove old cluster doc and update readme (#8486)
This is an automated email from the ASF dual-hosted git repository.
xingtanzjr 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 3fbc9175bf Remove old cluster doc and update readme (#8486)
3fbc9175bf is described below
commit 3fbc9175bf09c5d952cd74d75aa7fdd01ad5b93f
Author: Jialin Qiao <qj...@mails.tsinghua.edu.cn>
AuthorDate: Fri Dec 16 18:27:20 2022 +0800
Remove old cluster doc and update readme (#8486)
---
README.md | 48 ++++++++++++++++--------------------
README_ZH.md | 52 +++++++++++++++++----------------------
site/src/main/.vuepress/config.js | 28 ---------------------
3 files changed, 44 insertions(+), 84 deletions(-)
diff --git a/README.md b/README.md
index 1c4d497827..3c34ddae66 100644
--- a/README.md
+++ b/README.md
@@ -148,24 +148,39 @@ git clone https://github.com/apache/iotdb.git
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
+git checkout vx.x.x
```
-From v0.11.3 on, the tag name format is change to: vx.x.x:
+Or checkout to the branch of a big version, e.g., the branch of 1.0 is rel/1.0
```
-git checkout vx.x.x
+git checkout rel/x.x
```
+### Build IoTDB from source
+
Under the root path of iotdb:
```
-> mvn clean package -DskipTests
+> mvn clean package -pl distribution -am -DskipTests
```
-Using `-P compile-cpp` for compiling cpp client (For more details, read client-cpp's Readme file.)
+After being built, the IoTDB distribution is located at the folder: "distribution/target".
+
+
+### Only build cli
+
+Under the root path of iotdb:
-Then the binary version (including both server and cli) can be found at **distribution/target/apache-iotdb-{project.version}-all-bin.zip**
+```
+> mvn clean package -pl cli -am -DskipTests
+```
+
+After being built, the IoTDB cli is located at the folder "cli/target".
+
+### Build Others
+
+Using `-P compile-cpp` for compiling cpp client (For more details, read client-cpp's Readme file.)
**NOTE: Directories "`thrift/target/generated-sources/thrift`", "`thrift-sync/target/generated-sources/thrift`",
"`thrift-cluster/target/generated-sources/thrift`", "`thrift-influxdb/target/generated-sources/thrift`"
@@ -368,27 +383,6 @@ The server can be stopped with "ctrl-C" or the following script:
> sbin\stop-standalone.bat
```
-## Only build server
-
-Under the root path of iotdb:
-
-```
-> mvn clean package -pl server -am -DskipTests
-```
-
-After being built, the IoTDB server is located at the folder: "server/target/iotdb-server-{project.version}".
-
-
-## Only build cli
-
-Under the root path of iotdb:
-
-```
-> mvn clean package -pl cli -am -DskipTests
-```
-
-After being built, the IoTDB cli is located at the folder "cli/target/iotdb-cli-{project.version}".
-
# Usage of CSV Import and Export Tool
see [Usage of CSV Import and Export Tool](https://iotdb.apache.org/UserGuide/Master/Write-And-Delete-Data/CSV-Tool.html)
diff --git a/README_ZH.md b/README_ZH.md
index 6bfd2fbbe7..bc4da9747c 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -135,26 +135,41 @@ Thrift官方网址为：https://thrift.apache.org/
git clone https://github.com/apache/iotdb.git
```
-默认的主分支是master分支，如果你想使用某个发布版本x.x.x，请切换分支:
+默认的主分支是master分支，如果你想使用某个发布版本x.x.x，请切换 tag:
```
-git checkout release/x.x.x
+git checkout vx.x.x
```
-从0.11.3开始，版本的标签风格改为vx.x.x：
+或者切换大版本所在分支，如 1.0 版本的分支为 rel/1.0
+
```
-git checkout vx.x.x
+git checkout rel/x.x
```
-在 iotdb 根目录下执行 maven 编译:
+### 源码编译 IoTDB
+
+在 iotdb 根目录下执行:
```
-> mvn clean package -DskipTests
+> mvn clean package -pl distribution -am -DskipTests
```
-通过添加 `-P compile-cpp` 可以进行c++客户端API的编译。
+编译完成后, IoTDB 二进制包将生成在: "distribution/target".
+
+### 只编译 cli
+
+在 iotdb 根目录下执行:
+
+```
+> mvn clean package -pl cli -am -DskipTests
+```
+
+编译完成后, IoTDB cli 将生成在 "cli/target".
-执行完成之后，可以在**distribution/target/apache-iotdb-{project.version}-all-bin.zip**找到编译完成的二进制版本(包括服务器和客户端)
+### 编译其他模块
+
+通过添加 `-P compile-cpp` 可以进行c++客户端API的编译。
**注意："`thrift/target/generated-sources/thrift`"， "`thrift-sync/target/generated-sources/thrift`"，"`thrift-cluster/target/generated-sources/thrift`"，"`thrift-influxdb/target/generated-sources/thrift`" 和 "`antlr/target/generated-sources/antlr4`" 目录需要添加到源代码根中，以免在 IDE 中产生编译错误。**
@@ -360,27 +375,6 @@ server 可以使用 "ctrl-C" 或者执行下面的脚本:
> sbin\stop-standalone.bat
```
-## 只编译 server
-
-在 iotdb 根目录下执行:
-
-```
-> mvn clean package -pl server -am -DskipTests
-```
-
-编译完成后, IoTDB server 将生成在: "server/target/iotdb-server-{project.version}".
-
-
-## 只编译 cli
-
-在 iotdb 根目录下执行:
-
-```
-> mvn clean package -pl cli -am -DskipTests
-```
-
-编译完成后, IoTDB cli 将生成在 "cli/target/iotdb-cli-{project.version}".
-
# 导入导出CSV工具
查看 [导入导出CSV工具](https://iotdb.apache.org/zh/UserGuide/Master/Write-And-Delete-Data/CSV-Tool.html)
diff --git a/site/src/main/.vuepress/config.js b/site/src/main/.vuepress/config.js
index efa292a62e..d3c7b063db 100644
--- a/site/src/main/.vuepress/config.js
+++ b/site/src/main/.vuepress/config.js
@@ -625,13 +625,6 @@ var config = {
['Ecosystem Integration/Flink TsFile','Flink TsFile']
]
},
- {
- title: 'Cluster Setup',
- children: [
- ['Cluster/Cluster-Setup','Cluster Setup'],
- //['Cluster/Cluster-Setup-Example','Cluster Setup Example']
- ]
- },
{
title: 'FAQ',
children: [
@@ -797,13 +790,6 @@ var config = {
['Ecosystem Integration/NiFi-IoTDB','NiFi IoTDB'],
]
},
- {
- title: 'Cluster Setup',
- children: [
- ['Cluster/Cluster-Setup','Cluster Setup'],
- ['Cluster/Cluster-Setup-Example','Cluster Setup Example']
- ]
- },
{
title: 'UDF Library',
sidebarDepth: 1,
@@ -1843,13 +1829,6 @@ var config = {
['Ecosystem Integration/Flink IoTDB','Flink-IoTDB']
]
},
- {
- title: '集群搭建',
- children: [
- ['Cluster/Cluster-Setup','集群搭建'],
- //['Cluster/Cluster-Setup-Example','集群搭建示例']
- ]
- },
{
title: '常见问题',
children: [
@@ -2010,13 +1989,6 @@ var config = {
]
},
{
- title: '集群搭建',
- children: [
- ['Cluster/Cluster-Setup','集群搭建'],
- ['Cluster/Cluster-Setup-Example','集群搭建示例']
- ]
- },
- {
title: 'UDF 资料库',
sidebarDepth: 1,
children: [