Skip to content

Commit

Permalink
chore: update docs to match versions (IGinX-THU#404)
Browse files Browse the repository at this point in the history
* update versions in doc
  • Loading branch information
zhuyuqing authored Jul 22, 2024
1 parent 6ab0f6d commit 0b59cfa
Show file tree
Hide file tree
Showing 14 changed files with 118 additions and 118 deletions.
12 changes: 6 additions & 6 deletions docs/quickStarts/IGinXBySource-EnglishVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -424,17 +424,17 @@ Below is a short tutorial on how to use it.

### RPC Interface

Since the IGinX 0.5.1 version has not been released to the Maven central repository, if you want to use it, you need to manually install it to the local Maven repository.
Since the IGinX jars have not been released to the Maven central repository, if you want to use it, you need to manually install it to the local Maven repository.

The specific installation method is as follows:

```shell
# download iginx 0.4 release version source code package
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/release/v0.5.1.tar.gz
# download the newest IGinX release version source code package
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/v0.7.0.zip
# Unzip the source package
$ tar -zxvf v0.5.1.tar.gz
$ tar -zxvf v0.7.0.tar.gz
# go to the main project's directory
$ cd IGinX-rc-v0.5.1
$ cd IGinX-rc-v0.7.0
# Install to local Maven repository
$ mvn clean install -DskipTests
```
Expand All @@ -445,7 +445,7 @@ Specifically, when using it, you only need to introduce the following dependenci
<dependency>
<groupId>cn.edu.tsinghua</groupId>
<artifactId>iginx-core</artifactId>
<version>0.8.0-SNAPSHOT</version>
<version>0.7.0</version>
</dependency>
```

Expand Down
12 changes: 6 additions & 6 deletions docs/quickStarts/IGinXBySource.md
Original file line number Diff line number Diff line change
Expand Up @@ -421,15 +421,15 @@ RPC 接口最常见的用法。

下面是一个简短的使用教程。

由于目前 IGinX 0.5.1 版本还未发布到 maven 中央仓库,因此如需使用的话,需要手动安装到本地的 maven 仓库。具体安装方式如下:
由于目前 IGinX的jar包还未发布到 maven 中央仓库,因此如需使用的话,需要手动安装到本地的 maven 仓库。具体安装方式如下:

```shell
# 下载 IGinX 0.5.1 release 版本源码包
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/release/v0.5.1.tar.gz
# 下载 IGinX 最新release 版本源码包
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/v0.7.0.zip
# 解压源码包
$ tar -zxvf v0.5.1.tar.gz
$ tar -zxvf v0.7.0.tar.gz
# 进入项目主目录
$ cd IGinX-rc-v0.5.1
$ cd IGinX-rc-v0.7.0
# 安装到本地 maven 仓库
$ mvn clean install -DskipTests
```
Expand All @@ -440,7 +440,7 @@ $ mvn clean install -DskipTests
<dependency>
<groupId>cn.edu.tsinghua</groupId>
<artifactId>iginx-core</artifactId>
<version>0.8.0-SNAPSHOT</version>
<version>0.7.0</version>
</dependency>
```

Expand Down
14 changes: 7 additions & 7 deletions docs/quickStarts/IGinXCluster-EnglishVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ $ unzip apache-iotdb-0.12.6-server-bin.zip

### IGinX Installation

Go directly to the [IGinX project](https://github.com/IGinX-THU/IGinX) and download the [IGinX project release package](https://github.com/IGinX-THU/IGinX/releases/download/release%2Fv0.5.1/IGinX-release-v0.5.1-bin.tar.gz). That's it.
Go directly to the [IGinX project](https://github.com/IGinX-THU/IGinX) and download the [IGinX project release package](https://github.com/IGinX-THU/IGinX/releases/download/v0.7.0/IGinX-Server-0.7.0.tar.gz). That's it.

## Launch

Expand Down Expand Up @@ -337,15 +337,15 @@ In addition to the RESTful interface, IGinX also provides RPC data access interf

Below is a short tutorial on how to use it.

Since the IGinX 0.5.1 version has not been released to the maven central repository, if you want to use it, you need to manually install it to the local maven repository. The specific installation method is as follows:
Since the IGinX jars have not been released to the maven central repository, if you want to use it, you need to manually install it to the local maven repository. The specific installation method is as follows:

```shell
# Download IGinX 0.5.1 version source package
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/release/v0.5.1.tar.gz
# Download the newest IGinX version source package
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/v0.7.0.tar.gz
# Unzip the source package
$ tar -zxvf v0.5.1.tar.gz
$ tar -zxvf v0.7.0.tar.gz
# Enter the project's main directory
$ cd IGinX-release-v0.5.1
$ cd IGinX-release-v0.7.0
# Install to local maven repository
$ mvn clean install -DskipTests
```
Expand All @@ -356,7 +356,7 @@ Only when you are using it, you need to introduce the following dependencies in
<dependency>
<groupId>cn.edu.tsinghua</groupId>
<artifactId>iginx-core</artifactId>
<version>0.8.0-SNAPSHOT</version>
<version>0.7.0</version>
</dependency>
```

Expand Down
18 changes: 9 additions & 9 deletions docs/quickStarts/IGinXCluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,13 @@ $ unzip apache-iotdb-0.12.6-server-bin.zip

### IGinX 安装

直接访问 [IGinX 项目](https://github.com/IGinX-THU/IGinX)下载 [IGinX 项目发布包](https://github.com/IGinX-THU/IGinX/releases/download/release%2Fv0.5.1/IGinX-release-v0.5.1-bin.tar.gz)
直接访问 [IGinX 项目](https://github.com/IGinX-THU/IGinX)下载 [IGinX 项目发布包](https://github.com/IGinX-THU/IGinX/releases/download/v0.7.0/IGinX-Server-0.7.0.tar.gz)
即可。

```shell
$ cd ~
$ wget https://github.com/IGinX-THU/IGinX/releases/download/release%2Fv0.5.1/IGinX-release-v0.5.1-bin.tar.gz
$ tar -zxvf IGinX-release-v0.5.1-bin.tar.gz
$ wget https://github.com/IGinX-THU/IGinX/releases/download/v0.7.0/IGinX-Server-0.7.0.tar.gz
$ tar -zxvf IGinX-Server-0.7.0.tar.gz
```

## 启动
Expand Down Expand Up @@ -344,15 +344,15 @@ RPC 接口最常见的用法。

下面是一个简短的使用教程。

由于目前 IGinX 0.5.1 版本还未发布到 maven 中央仓库,因此如需使用的话,需要手动安装到本地的 maven 仓库。具体安装方式如下:
由于目前 IGinX jar包还未发布到 maven 中央仓库,因此如需使用的话,需要手动安装到本地的 maven 仓库。具体安装方式如下:

```shell
# 下载 IGinX 0.5.1 release 版本源码包
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/release/v0.5.1.tar.gz
# 下载 IGinX 最新release 版本源码包
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/v0.7.0.tar.gz
# 解压源码包
$ tar -zxvf v0.5.1.tar.gz
$ tar -zxvf v0.7.0.tar.gz
# 进入项目主目录
$ cd IginX-release-v0.5.1
$ cd IginX-release-v0.7.0
# 安装到本地 maven 仓库
$ mvn clean install -DskipTests
```
Expand All @@ -363,7 +363,7 @@ $ mvn clean install -DskipTests
<dependency>
<groupId>cn.edu.tsinghua</groupId>
<artifactId>iginx-core</artifactId>
<version>0.8.0-SNAPSHOT</version>
<version>0.7.0</version>
</dependency>
```

Expand Down
18 changes: 9 additions & 9 deletions docs/quickStarts/IGinXInOneShot-EnglishVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,15 @@ IGinX is the main part of the system, and the installation package can be downlo

```shell
$ cd ~
$ wget https://github.com/IGinX-THU/IGinX/releases/download/release%2Fv0.5.1/IGinX-FastDeploy-v0.5.1-bin.tar.gz
$ tar -xzvf IGinX-FastDeploy-v0.5.1-bin.tar.gz
$ wget https://github.com/IGinX-THU/IGinX/releases/download/v0.7.0/IGinX-FastDeploy-0.7.0.tar.gz
$ tar -xzvf IGinX-FastDeploy-0.7.0.tar.gz
```

## Launch

```shell
$ cd ~
$ cd IGinX-FastDeploy-v0.5.0-bin
$ cd IGinX-FastDeploy-0.7.0
$ chmod +x ./runIginxOn1Host.sh
$ ./runIginxOn1Host.sh
```
Expand Down Expand Up @@ -251,17 +251,17 @@ Below is a short tutorial on how to use it.
### RPC Interface
Since the IGinX 0.5.1 version has not been released to the Maven central repository, if you want to use it, you need to manually install it to the local Maven repository.
Since the IGinX jars have not been released to the Maven central repository, if you want to use it, you need to manually install it to the local Maven repository.
The specific installation method is as follows:
```shell
# download iginx 0.4 release version source code package
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/release/v0.5.1.tar.gz
# download the newest IGinX release version source code package
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/v0.7.0.tar.gz
# Unzip the source package
$ tar -zxvf v0.5.1.tar.gz
$ tar -zxvf v0.7.0.tar.gz
# go to the main project's directory
$ cd IGinX-release-v0.5.1
$ cd IGinX-release-v0.7.0
# Install to local Maven repository
$ mvn clean install -DskipTests
```
Expand All @@ -272,7 +272,7 @@ Specifically, when using it, you only need to introduce the following dependenci
<dependency>
<groupId>cn.edu.tsinghua</groupId>
<artifactId>iginx-core</artifactId>
<version>0.8.0-SNAPSHOT</version>
<version>0.7.0</version>
</dependency>
```
Expand Down
18 changes: 9 additions & 9 deletions docs/quickStarts/IGinXInOneShot.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,15 @@ IGinX 为系统的主体部分,通过一键启动安装包

```shell
$ cd ~
$ wget https://github.com/IGinX-THU/IGinX/releases/download/release%2Fv0.5.1/IGinX-FastDeploy-v0.5.1-bin.tar.gz
$ tar -xzvf IGinX-FastDeploy-v0.5.1-bin.tar.gz
$ wget https://github.com/IGinX-THU/IGinX/releases/download/v0.7.0/IGinX-FastDeploy-0.7.0.tar.gz
$ tar -xzvf IGinX-FastDeploy-v0.7.0-bin.tar.gz
```

## 启动

```shell
$ cd ~
$ cd IGinX-FastDeploy-v0.5.0-bin
$ cd IGinX-FastDeploy-0.7.0
$ chmod +x ./runIginxOn1Host.sh
$ ./runIginxOn1Host.sh
```
Expand Down Expand Up @@ -247,15 +247,15 @@ RPC 接口最常见的用法。
下面是一个简短的使用教程。
由于目前 IGinX 0.5.1 版本还未发布到 maven 中央仓库,因此如需使用的话,需要手动安装到本地的 maven 仓库。具体安装方式如下:
由于目前 IGinX jar包还未发布到 maven 中央仓库,因此如需使用的话,需要手动安装到本地的 maven 仓库。具体安装方式如下:
```shell
# 下载 IGinX 0.5.1 release 版本源码包
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/release/v0.5.1.tar.gz
# 下载 IGinX 最新release 版本源码包
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/v0.7.0.zip
# 解压源码包
$ tar -zxvf v0.5.1.tar.gz
$ tar -zxvf v0.7.0.tar.gz
# 进入项目主目录
$ cd IGinX-release-v0.5.1
$ cd IGinX-release-v0.7.0
# 安装到本地 maven 仓库
$ mvn clean install -DskipTests
```
Expand All @@ -266,7 +266,7 @@ $ mvn clean install -DskipTests
<dependency>
<groupId>cn.edu.tsinghua</groupId>
<artifactId>iginx-core</artifactId>
<version>0.8.0-SNAPSHOT</version>
<version>0.7.0</version>
</dependency>
```
Expand Down
24 changes: 12 additions & 12 deletions docs/quickStarts/IGinXManual-EnglishVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,12 @@ $ unzip apache-iotdb-0.12.6-server-bin.zip

### Download the binary executables

Go directly to the [IGinX project](https://github.com/IGinX-THU/IGinX) and download the [IGinX project release package](https://github.com/IGinX-THU/IGinX/releases/download/release%2Fv0.5.1/IGinX-release-v0.5.1-bin.tar.gz).
Go directly to the [IGinX project](https://github.com/IGinX-THU/IGinX) and download the [IGinX project release package](https://github.com/IGinX-THU/IGinX/releases/download/v0.7.0/IGinX-Server-0.7.0.tar.gz).

```shell
$ cd ~
$ wget https://github.com/IGinX-THU/IGinX/releases/download/release%2Fv0.5.1/IGinX-release-v0.5.1-bin.tar.gz
$ tar -xzvf IGinX-release-v0.5.1-bin.tar.gz
$ wget https://github.com/IGinX-THU/IGinX/releases/download/v0.7.0/IGinX-Server-0.7.0.tar.gz
$ tar -xzvf IGinX-Server-0.7.0.tar.gz
```

### Compilation with source code
Expand Down Expand Up @@ -191,7 +191,7 @@ The following display of words means the IoTDB installation was successful:

#### Launch ZooKeeper

If you are taking a 0.2.0 binary installation package, or if you designate Zookeeper as the metadata management storage backend in the configuration file, you need to launch ZooKeeper. Otherwise, **skip this step entirely**.
If you are taking a binary installation package, or if you designate Zookeeper as the metadata management storage backend in the configuration file, you need to launch ZooKeeper. Otherwise, **skip this step entirely**.

```shell
$ cd ~
Expand All @@ -213,7 +213,7 @@ Using the release package to launch

```shell
$ cd ~
$ cd IGinX-release-v0.5.1-bin
$ cd IGinX-Server-0.7.0
$ chmod +x startIginX.sh # enable permissions for startup scripts
$ ./startIginX.sh
```
Expand Down Expand Up @@ -484,15 +484,15 @@ In addition to the RESTful interface, IGinX also provides RPC data access interf

Below is a short tutorial on how to use it.

Since the IGinX 0.5.1 version has not been released to the maven central repository, if you want to use it, you need to manually install it to the local maven repository. The specific installation method is as follows:
Since the IGinX jars have not been released to the maven central repository, if you want to use it, you need to manually install it to the local maven repository. The specific installation method is as follows:

```shell
# Download iginx 0.2 rc version source package
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/release/v0.5.1.tar.gz
# Download the newest IGinX version source package
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/v0.7.0.tar.gz
# Unzip the source package
$ tar -zxvf v0.5.1.tar.gz
$ tar -zxvf v0.7.0.tar.gz
# Enter the project main directory
$ cd IGinX-rc-v0.5.1
$ cd IGinX-v0.7.0
# Install to local maven repository
$ mvn clean install -DskipTests
```
Expand All @@ -503,7 +503,7 @@ Only when you are using it, you need to introduce the following dependencies in
<dependency>
<groupId>cn.edu.tsinghua</groupId>
<artifactId>iginx-core</artifactId>
<version>0.8.0-SNAPSHOT</version>
<version>0.7.0</version>
</dependency>
```

Expand Down Expand Up @@ -639,7 +639,7 @@ For the full version of the code, please refer to: https://github.com/IGinX-THU/
<dependency>
<groupId>cn.edu.tsinghua</groupId>
<artifactId>iginx-session</artifactId>
<version>0.5.1</version>
<version>0.7.0</version>
</dependency>
</dependencies>

24 changes: 12 additions & 12 deletions docs/quickStarts/IGinXManual.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,13 +139,13 @@ $ unzip apache-iotdb-0.12.6-server-bin.zip

### 下载二进制可执行文件

直接访问 [IGinX 项目](https://github.com/IGinX-THU/IGinX)下载 [IGinX 项目发布包](https://github.com/IGinX-THU/IGinX/releases/download/release%2Fv0.5.1/IGinX-release-v0.5.1-bin.tar.gz)
直接访问 [IGinX 项目](https://github.com/IGinX-THU/IGinX)下载 [IGinX 项目发布包](https://github.com/IGinX-THU/IGinX/releases/download/v0.7.0/IGinX-Server-0.7.0.tar.gz)
即可

```shell
$ cd ~
$ wget https://github.com/IGinX-THU/IGinX/releases/download/release%2Fv0.5.1/IGinX-release-v0.5.1-bin.tar.gz
$ tar -zxvf IGinX-release-v0.5.1-bin.tar.gz
$ wget https://github.com/IGinX-THU/IGinX/releases/download/v0.7.0/IGinX-Server-0.7.0.tar.gz
$ tar -zxvf IGinX-Server-0.7.0.tar.gz
```

### 使用源码编译
Expand Down Expand Up @@ -189,7 +189,7 @@ $ ./sbin/start-server.sh

#### 启动 ZooKeeper

如果您采取的是 0.5.1 的二进制安装包,或者在配置文件中指定 ZooKeeper 为元数据管理存储后端,需要启动ZooKeeper。否则,**直接跳过此步骤**
如果您采取的是IGinX的快速部署安装包,或者在配置文件中指定 ZooKeeper 为元数据管理存储后端,需要启动ZooKeeper。否则,**直接跳过此步骤**

```shell
$ cd ~
Expand All @@ -211,7 +211,7 @@ Starting zookeeper ... STARTED

```shell
$ cd ~
$ cd IGinX-release-v0.5.1-bin
$ cd IGinX-Server-0.7.0
$ chmod +x startIginX.sh # 为启动脚本添加启动权限
$ ./startIginX.sh
```
Expand Down Expand Up @@ -485,15 +485,15 @@ RPC 接口最常见的用法。

下面是一个简短的使用教程。

由于目前 IGinX 0.5.1 版本还未发布到 maven 中央仓库,因此如需使用的话,需要手动安装到本地的 maven 仓库。具体安装方式如下:
由于目前 IGinX jar包还未发布到 maven 中央仓库,因此如需使用的话,需要手动安装到本地的 maven 仓库。具体安装方式如下:

```shell
# 下载 IGinX 0.5.1 release 版本源码包
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/release/v0.5.1.tar.gz
# 下载 IGinX 最新release 版本源码包
$ wget https://github.com/IGinX-THU/IGinX/archive/refs/tags/v0.7.0.tar.gz
# 解压源码包
$ tar -zxvf v0.5.1.tar.gz
$ tar -zxvf v0.7.0.tar.gz
# 进入项目主目录
$ cd IGinX-release-v0.5.1
$ cd IGinX-release-v0.7.0
# 安装到本地 maven 仓库
$ mvn clean install -DskipTests
```
Expand All @@ -504,7 +504,7 @@ $ mvn clean install -DskipTests
<dependency>
<groupId>cn.edu.tsinghua</groupId>
<artifactId>iginx-core</artifactId>
<version>0.8.0-SNAPSHOT</version>
<version>0.7.0</version>
</dependency>
```

Expand Down Expand Up @@ -641,7 +641,7 @@ session.closeSession();
<dependency>
<groupId>cn.edu.tsinghua</groupId>
<artifactId>iginx-session</artifactId>
<version>0.5.1</version>
<version>0.7.0</version>
</dependency>
</dependencies>

Loading

0 comments on commit 0b59cfa

Please sign in to comment.