You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by hx...@apache.org on 2020/11/26 20:31:11 UTC
[iotdb] 01/02: update website and refactore how to compile the
website
This is an automated email from the ASF dual-hosted git repository.
hxd pushed a commit to branch move_site_compile_into_seperate_profile
in repository https://gitbox.apache.org/repos/asf/iotdb.git
commit f14844beaea9fdf2663ac003acb6579d32f55aec
Author: xiangdong huang <sa...@gmail.com>
AuthorDate: Fri Nov 27 04:02:30 2020 +0800
update website and refactore how to compile the website
---
docs/Download/README.md | 24 +-
docs/zh/Download/README.md | 31 ++-
site/README-zh.md | 8 +-
site/README.md | 15 +-
site/pom.xml | 563 +++++++++++++++++++++++++++++++-------
site/src/main/.vuepress/config.js | 374 ++++++++++++++++++++++++-
site/src/main/package.json | 6 +-
7 files changed, 900 insertions(+), 121 deletions(-)
diff --git a/docs/Download/README.md b/docs/Download/README.md
index f3d0f40..bdcfcff 100644
--- a/docs/Download/README.md
+++ b/docs/Download/README.md
@@ -29,6 +29,16 @@
<th>release notes</th>
</tr>
<tr>
+ <td>0.11.0</td>
+ <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.11.0/apache-iotdb-0.11.0-bin.zip">Release</a></td>
+ <td><a href="https://downloads.apache.org/iotdb/0.11.0/apache-iotdb-0.11.0-bin.zip.sha512">SHA512</a></td>
+ <td><a href="https://downloads.apache.org/iotdb/0.11.0/apache-iotdb-0.11.0-bin.zip.asc">ASC</a></td>
+ <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.11.0/apache-iotdb-0.11.0-source-release.zip">Sources</a></td>
+ <td><a href="https://downloads.apache.org/iotdb/0.11.0/apache-iotdb-0.11.0-source-release.zip.sha512">SHA512</a></td>
+ <td><a href="https://downloads.apache.org/iotdb/0.11.0/apache-iotdb-0.11.0-source-release.zip.asc">ASC</a></td>
+ <td><a href="https://raw.githubusercontent.com/apache/iotdb/release/0.11.0/RELEASE_NOTES.md">release notes</a></td>
+ </tr>
+ <tr>
<td>0.10.1</td>
<td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.10.1-incubating/apache-iotdb-0.10.1-incubating-bin.zip">Release</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.10.1-incubating/apache-iotdb-0.10.1-incubating-bin.zip.sha512">SHA512</a></td>
@@ -69,13 +79,25 @@
with what you set in the old version.
* stop the old vesion instance, and start the new one.
+- - How to upgrade from v.10.x to v0.11.x?
+ * The data format (i.e., TsFile data) of v0.10.x and v0.11 are compatible, but the WAL file is incompatible.
+ * So, you can follow the steps:
+ * Stop writing new data.
+ * Call `flush` command using sbin/start-cli.sh in v0.10.x to close all TsFiles.
+ * We recommend to backup the the wal files and mlog.txt before upgrading for rolling back.
+ * Just download, unzip v0.11.x.zip, and modify conf/iotdb-engine.proeprties to let all the
+ directories point to the data folder set in v0.10.x (or the backup folder).
+ You can also modify other settings if you want.
+ * Stop IoTDB v0.10.x instance, and start v0.11.x, then the IoTDB will upgrade data file format automatically.
+ * __NOTICE: V0.11 changes many settings in conf/iotdb-engine.properties, so do not use v0.10's configuration file directly.__
+
- How to upgrade from v.9.x to v0.10.x?
* Upgrading from v0.9 to v0.10 is more complex than v0.8 to v0.9.
* Stop writing new data.
* Call `flush` command using sbin/start-client.sh in v0.9 to close all TsFiles.
* We recommend to backup the data file (also the wal files and mlog.txt) before upgrading for rolling back.
* Just download, unzip v0.10.x.zip, and modify conf/iotdb-engine.proeprties to let all the
- directories point to the folders set in v0.9.x (or the backup folder).
+ directories point to the data folder set in v0.9.x (or the backup folder).
You can also modify other settings if you want.
* Stop IoTDB v0.9 instance, and start v0.10.x, then the IoTDB will upgrade data file format automatically.
diff --git a/docs/zh/Download/README.md b/docs/zh/Download/README.md
index beaa88c..e770aa7 100644
--- a/docs/zh/Download/README.md
+++ b/docs/zh/Download/README.md
@@ -28,31 +28,41 @@
<th>release notes</th>
</tr>
<tr>
+ <td>0.11.0</td>
+ <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.11.0/apache-iotdb-0.11.0-bin.zip">可执行程序</a></td>
+ <td><a href="https://downloads.apache.org/iotdb/0.11.0/apache-iotdb-0.11.0-bin.zip.sha512">SHA512</a></td>
+ <td><a href="https://downloads.apache.org/iotdb/0.11.0/apache-iotdb-0.11.0-bin.zip.asc">ASC</a></td>
+ <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.11.0/apache-iotdb-0.11.0-source-release.zip">源代码</a></td>
+ <td><a href="https://downloads.apache.org/iotdb/0.11.0/apache-iotdb-0.11.0-source-release.zip.sha512">SHA512</a></td>
+ <td><a href="https://downloads.apache.org/iotdb/0.11.0/apache-iotdb-0.11.0-source-release.zip.asc">ASC</a></td>
+ <td><a href="https://raw.githubusercontent.com/apache/iotdb/release/0.11.0/RELEASE_NOTES.md">release notes</a></td>
+ </tr>
+ <tr>
<td>0.10.1</td>
- <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.10.1-incubating/apache-iotdb-0.10.1-incubating-bin.zip">Release</a></td>
+ <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.10.1-incubating/apache-iotdb-0.10.1-incubating-bin.zip">可执行程序</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.10.1-incubating/apache-iotdb-0.10.1-incubating-bin.zip.sha512">SHA512</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.10.1-incubating/apache-iotdb-0.10.1-incubating-bin.zip.asc">ASC</a></td>
- <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.10.1-incubating/apache-iotdb-0.10.1-incubating-source-release.zip">Sources</a></td>
+ <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.10.1-incubating/apache-iotdb-0.10.1-incubating-source-release.zip">源代码</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.10.1-incubating/apache-iotdb-0.10.1-incubating-source-release.zip.sha512">SHA512</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.10.1-incubating/apache-iotdb-0.10.1-incubating-source-release.zip.asc">ASC</a></td>
<td><a href="https://raw.githubusercontent.com/apache/iotdb/release/0.10.1/RELEASE_NOTES.md">release notes</a></td>
</tr>
<tr>
<td>0.9.3</td>
- <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.9.3-incubating/apache-iotdb-0.9.3-incubating-bin.zip">Release</a></td>
+ <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.9.3-incubating/apache-iotdb-0.9.3-incubating-bin.zip">可执行程序</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.9.3-incubating/apache-iotdb-0.9.3-incubating-bin.zip.sha512">SHA512</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.9.3-incubating/apache-iotdb-0.9.3-incubating-bin.zip.asc">ASC</a></td>
- <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.9.3-incubating/apache-iotdb-0.9.3-incubating-source-release.zip">Sources</a></td>
+ <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.9.3-incubating/apache-iotdb-0.9.3-incubating-source-release.zip">源代码</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.9.3-incubating/apache-iotdb-0.9.3-incubating-source-release.zip.sha512">SHA512</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.9.3-incubating/apache-iotdb-0.9.3-incubating-source-release.zip.asc">ASC</a></td>
<td><a href="https://raw.githubusercontent.com/apache/iotdb/release/0.9.3/RELEASE_NOTES.md">release notes</a></td>
</tr>
<tr>
<td>0.8.2</td>
- <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.8.2-incubating/apache-iotdb-0.8.2-incubating-bin.zip">Release</a></td>
+ <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.8.2-incubating/apache-iotdb-0.8.2-incubating-bin.zip">可执行程序</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.8.2-incubating/apache-iotdb-0.8.2-incubating-bin.zip.sha512">SHA512</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.8.2-incubating/apache-iotdb-0.8.2-incubating-bin.zip.asc">ASC</a></td>
- <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.8.2-incubating/apache-iotdb-0.8.2-incubating-source-release.zip">Sources</a></td>
+ <td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/0.8.2-incubating/apache-iotdb-0.8.2-incubating-source-release.zip">源代码</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.8.2-incubating/apache-iotdb-0.8.2-incubating-source-release.zip.sha512">SHA512</a></td>
<td><a href="https://downloads.apache.org/iotdb/0.8.2-incubating/apache-iotdb-0.8.2-incubating-source-release.zip.asc">ASC</a></td>
<td><a href="https://raw.githubusercontent.com/apache/iotdb/release/0.8.2/RELEASE_NOTES.md">release notes</a></td>
@@ -67,6 +77,15 @@
* 只需要下载新的小版本， 然后修改其配置文件，使其与原有版本的设置一致。
* 停掉旧版本进程，启动新版本即可。
+- 如何从v0.10.x 升级到 v0.11.x?
+ * 0.10 与0.11的数据文件格式兼容，但写前日志等格式不兼容，因此需要进行升级（但速度很快）：
+ * 停掉0.10的新数据写入。
+ * 用CLI调用`flush`，确保关闭所有的TsFile文件.
+ * 我们推荐提前备份写前日志和mlog文件，以备回滚。
+ * 下载最新版，解压并修改配置文件。将各数据目录都指向备份的或者v0.10原来使用的数据目录。
+ * 停止v0.10的实例，启动v0.11的实例。IoTDB将自动升级不兼容的文件格式。
+ * __注意：0.11的配置文件进行了较大改动，因此不要直接将0.10的配置文件用于0.11__
+
- 如何从v0.9.x 升级到 v0.10.x?
* 停掉0.9的新数据写入。
* 用CLI调用`flush`，确保关闭所有的TsFile文件.
diff --git a/site/README-zh.md b/site/README-zh.md
index 1ebf68e..123f17c 100644
--- a/site/README-zh.md
+++ b/site/README-zh.md
@@ -29,11 +29,11 @@
## 如何建立
-跑`mvn package -DskipTests -P compile-site`
+跑`mvn compile -DskipTests -P compile-site -P download-website`
## 如何调试
-当跑完 `mvn package -DskipTests -P compile-site`, 所有的源文档都会复制到target/vue-source目录下
+当跑完 `mvn generate-sources -DskipTests -P compile-site`, 所有的源文档都会复制到target/vue-source目录下
如果你想要调试：
@@ -50,11 +50,11 @@ npm run build
## 手动部署
-跑`mvn package scm-publish:publish-scm -P compile-site`.
+跑`mvn compile scm-publish:publish-scm -P compile-site`.
Apache ID和密码是必须的
-或直接运行`mvn package scm-publish:publish-scm -Dusername={你的Apache ID} -Dpassword={你的Apache账号密码} -P compile-site`
+或直接运行`mvn compile scm-publish:publish-scm -Dusername={你的Apache ID} -Dpassword={你的Apache账号密码} -P compile-site`
## 常见问题
diff --git a/site/README.md b/site/README.md
index cd893f8..5c2d1b4 100644
--- a/site/README.md
+++ b/site/README.md
@@ -32,16 +32,21 @@ See https://iotdb.apache.org/
## Build Setup
-run `mvn package -DskipTests -P compile-site` for doing the following steps automatically:
+run `mvn compile -DskipTests -P compile-site -P download-website` for doing the following steps automatically:
- get docs from the master branch and all lagecy docs remotely.
- download node.js and npm;
-- run `npm install` and `npm run build -P compile-site`
+- run `npm install` and `npm run build`
+- the final website will be generated in `target/vue-source/src/.vuepress/dist`
+
+Notice that we will only compile the docs from the master branch, and just copy static htmls from
+iotdb-website. If you want to compile lagecy docs, using `-P compile-site-<version>`,
+e.g., `mvn compile -P compile-site -P compile-site-0.11 -P compile-site-0.10`
## How to Debug
-after running `mvn package -DskipTests`, all source codes are copied into target/vue-source
+after running `mvn compile -DskipTests`, all source codes are copied into target/vue-source
then if you want to debug, just run
@@ -58,11 +63,11 @@ All changes in the target folder will be ignored by Git.
## Deploy Manually
-run `mvn package scm-publish:publish-scm -P compile-site`.
+run `mvn compile scm-publish:publish-scm -P compile-site`.
Apache ID and passwored is needed.
-Or run `mvn package scm-publish:publish-scm -Dusername={YOUR_APACHE_ID} -Dpassword={YOUR_APACHE_PASSWORD} -P compile-site`
+Or run `mvn compile scm-publish:publish-scm -Dusername={YOUR_APACHE_ID} -Dpassword={YOUR_APACHE_PASSWORD} -P compile-site`
## FAQ
diff --git a/site/pom.xml b/site/pom.xml
index 6c58749..4c14811 100644
--- a/site/pom.xml
+++ b/site/pom.xml
@@ -38,27 +38,112 @@
</site>
</distributionManagement>
<profiles>
+ <!--
+ Process:
+ 1. download existing static website from github
+ 2. copy and unpack it to a tmp folder
+ 3. if site-compile-0.x is enabled, download files of 0.x from github,
+ (except the master branch). copy it to the source tmp folder
+ 4. compiling...
+ 5. if site-compile-0.x is disabled, copy existing static files from the tmp folder to the
+ target folder.
+ 6. upload to github website
+ -->
<profile>
- <id>compile-site</id>
+ <id>download-site</id>
<build>
<plugins>
- <!-- copy source codes into vue required folders-->
+ <!-- download existing website from iotdb repo -->
+ <plugin>
+ <groupId>com.googlecode.maven-download-plugin</groupId>
+ <artifactId>download-maven-plugin</artifactId>
+ <version>1.3.0</version>
+ <executions>
+ <execution>
+ <id>get-existing-site</id>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>wget</goal>
+ </goals>
+ <configuration>
+ <url>https://github.com/apache/iotdb-website/archive/asf-site.zip</url>
+ <outputDirectory>${project.build.directory}/download</outputDirectory>
+ <outputFileName>website.zip</outputFileName>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <!-- unpack existing website from the zip files-->
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>truezip-maven-plugin</artifactId>
+ <version>1.2</version>
+ <inherited>false</inherited>
+ <executions>
+ <execution>
+ <id>unpack-existing-docs</id>
+ <goals>
+ <goal>copy</goal>
+ </goals>
+ <phase>generate-sources</phase>
+ <configuration>
+ <fileset>
+ <directory>${project.build.directory}/download/website.zip/iotdb-website-asf-site/UserGuide</directory>
+ <outputDirectory>${project.build.directory}/existing/UserGuide</outputDirectory>
+ </fileset>
+ </configuration>
+ </execution>
+ <execution>
+ <id>unpack-existing-zh-docs</id>
+ <goals>
+ <goal>copy</goal>
+ </goals>
+ <phase>generate-sources</phase>
+ <configuration>
+ <fileset>
+ <directory>${project.build.directory}/download/website.zip/iotdb-website-asf-site/zh/UserGuide</directory>
+ <outputDirectory>${project.build.directory}/existing/zh/UserGuide</outputDirectory>
+ </fileset>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <!-- Copy existing documents-->
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<executions>
+ <!-- copy source codes into vue required folders-->
<execution>
- <id>copy-source-code-to-docs-folder</id>
+ <id>copy-existing-docs-to-dist</id>
<!-- here the phase you need -->
- <phase>generate-sources</phase>
+ <phase>package</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
- <outputDirectory>${project.build.directory}/vue-source/src</outputDirectory>
+ <outputDirectory>${project.build.directory}/vue-source/src/.vuepress/dist/UserGuide</outputDirectory>
<!-- output directory -->
<resources>
<resource>
- <directory>${basedir}/src/main/</directory>
+ <directory>${project.build.directory}/existing/UserGuide/</directory>
+ <filtering>true</filtering>
+ </resource>
+ </resources>
+ </configuration>
+ </execution>
+ <execution>
+ <id>copy-existing-zh-docs-to-dist</id>
+ <!-- here the phase you need -->
+ <phase>package</phase>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.build.directory}/vue-source/src/.vuepress/dist/zh/UserGuide</outputDirectory>
+ <!-- output directory -->
+ <resources>
+ <resource>
+ <directory>${project.build.directory}/existing/zh/UserGuide/</directory>
<filtering>true</filtering>
</resource>
</resources>
@@ -66,12 +151,41 @@
</execution>
</executions>
</plugin>
+ </plugins>
+ </build>
+ </profile>
+ <profile>
+ <!-- by default, only the master branch is compiled and uploaded.
+ Use -Dsite.download.existing.htmls=true to contain all other htmls (v0.8,v0.9 etc..)
+ -->
+ <id>compile-site</id>
+ <build>
+ <plugins>
<!-- Copy master documents-->
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<executions>
+ <!-- copy source codes into vue required folders-->
+ <execution>
+ <id>copy-source-code-to-vue-source-folder</id>
+ <!-- here the phase you need -->
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.build.directory}/vue-source/src</outputDirectory>
+ <!-- output directory -->
+ <resources>
+ <resource>
+ <directory>${basedir}/src/main/</directory>
+ <filtering>true</filtering>
+ </resource>
+ </resources>
+ </configuration>
+ </execution>
<execution>
- <id>copy-master-docs-to-docs</id>
+ <id>copy-master-docs-to-vue-source-folder</id>
<!-- here the phase you need -->
<phase>generate-sources</phase>
<goals>
@@ -83,6 +197,45 @@
<resources>
<resource>
<directory>${basedir}/../docs</directory>
+ <excludes>
+ <exclude>UserGuide/**/*</exclude>
+ <exclude>zh/UserGuide/**/*</exclude>
+ </excludes>
+ </resource>
+ </resources>
+ </configuration>
+ </execution>
+ <execution>
+ <id>copy-master-userguide-docs-to-vue-source-folder</id>
+ <!-- here the phase you need -->
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.build.directory}/vue-source/src/UserGuide/Master</outputDirectory>
+ <!-- output directory -->
+ <resources>
+ <resource>
+ <directory>${basedir}/../docs/UserGuide</directory>
+ <filtering>true</filtering>
+ </resource>
+ </resources>
+ </configuration>
+ </execution>
+ <execution>
+ <id>copy-master-zh-userguide-docs-to-vue-source-folder</id>
+ <!-- here the phase you need -->
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.build.directory}/vue-source/src/zh/UserGuide/Master</outputDirectory>
+ <!-- output directory -->
+ <resources>
+ <resource>
+ <directory>${basedir}/../docs/zh/UserGuide</directory>
<filtering>true</filtering>
</resource>
</resources>
@@ -142,7 +295,7 @@
</execution>
</executions>
</plugin>
- <!-- mv UserGuide of master into master folder -->
+ <!-- copy single files, and move UserGuide of master into tmp folder -->
<plugin>
<groupId>com.coderplus.maven.plugins</groupId>
<artifactId>copy-rename-maven-plugin</artifactId>
@@ -167,75 +320,225 @@
</fileSets>
</configuration>
</execution>
+ <!-- remove files if `existing` folder exist-->
<execution>
- <id>mv-master-userguide-to-tmp-folder</id>
+ <id>clean-stale-master-doc</id>
<phase>generate-sources</phase>
<goals>
<goal>rename</goal>
</goals>
<configuration>
- <sourceFile>${project.build.directory}/vue-source/src/UserGuide</sourceFile>
- <destinationFile>${project.build.directory}/vue-source/src/tmpUserGuide/Master</destinationFile>
+ <sourceFile>${project.build.directory}/existing/UserGuide/Master</sourceFile>
+ <destinationFile>${project.build.directory}/abandon/UserGuide/Master</destinationFile>
</configuration>
</execution>
<execution>
- <id>mv-master-zh-userguide-to-tmp-folder</id>
+ <id>clean-stale-master-zh-doc</id>
<phase>generate-sources</phase>
<goals>
<goal>rename</goal>
</goals>
<configuration>
- <sourceFile>${project.build.directory}/vue-source/src/zh/UserGuide</sourceFile>
- <destinationFile>${project.build.directory}/vue-source/src/zh/tmpUserGuide/Master</destinationFile>
+ <sourceFile>${project.build.directory}/existing/zh/UserGuide/Master</sourceFile>
+ <destinationFile>${project.build.directory}/abandon/zh/UserGuide/Master</destinationFile>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <!--install node and npm， then run `npm install` and `npm run build`-->
+ <plugin>
+ <groupId>com.github.eirslett</groupId>
+ <artifactId>frontend-maven-plugin</artifactId>
+ <version>1.9.1</version>
+ <configuration>
+ <installDirectory>${project.build.directory}/tools</installDirectory>
+ <workingDirectory>${project.build.directory}/vue-source</workingDirectory>
+ </configuration>
+ <executions>
+ <execution>
+ <id>install-node-and-npm</id>
+ <goals>
+ <goal>install-node-and-npm</goal>
+ </goals>
+ <phase>compile</phase>
+ <configuration>
+ <nodeVersion>v12.16.2</nodeVersion>
+ <npmVersion>6.14.4</npmVersion>
+ </configuration>
+ </execution>
+ <!-- Install all project dependencies -->
+ <execution>
+ <id>npm install</id>
+ <goals>
+ <goal>npm</goal>
+ </goals>
+ <!-- optional: default phase is "generate-resources" -->
+ <phase>compile</phase>
+ <!-- Optional configuration which provides for running any npm command -->
+ <configuration>
+ <arguments>install</arguments>
+ </configuration>
+ </execution>
+ <!-- Build and minify static files -->
+ <execution>
+ <id>npm run build</id>
+ <phase>compile</phase>
+ <goals>
+ <goal>npm</goal>
+ </goals>
+ <configuration>
+ <arguments>run build</arguments>
</configuration>
</execution>
</executions>
</plugin>
- <!-- download lagecy docs from iotdb repo -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-publish-plugin</artifactId>
+ <configuration>
+ <!-- mono-module doesn't require site:stage -->
+ <content>${project.build.directory}/vue-source/src/.vuepress/dist</content>
+ <!-- branch where to deploy -->
+ <scmBranch>asf-site</scmBranch>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.simplify4u.plugins</groupId>
+ <artifactId>sitemapxml-maven-plugin</artifactId>
+ <version>2.0.0</version>
+ <configuration>
+ <siteOutputDirectory>${project.build.directory}/vue-source/src/.vuepress/dist</siteOutputDirectory>
+ <maxDepth>5</maxDepth>
+ </configuration>
+ <executions>
+ <execution>
+ <phase>compile</phase>
+ <goals>
+ <goal>gen</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ <profile>
+ <id>compile-site-0.11</id>
+ <build>
+ <plugins>
+ <!-- download 0.11 docs from iotdb repo -->
<plugin>
<groupId>com.googlecode.maven-download-plugin</groupId>
<artifactId>download-maven-plugin</artifactId>
<version>1.3.0</version>
<executions>
<execution>
- <id>get-0.10-docs</id>
+ <id>get-0.11-docs</id>
<phase>generate-sources</phase>
<goals>
<goal>wget</goal>
</goals>
<configuration>
- <url>https://github.com/apache/iotdb/archive/rel/0.10.zip</url>
+ <url>https://github.com/apache/iotdb/archive/rel/0.11.zip</url>
<outputDirectory>${project.build.directory}/download</outputDirectory>
- <outputFileName>0.10.x.zip</outputFileName>
+ <outputFileName>0.11.x.zip</outputFileName>
</configuration>
</execution>
+ </executions>
+ </plugin>
+ <!-- unpack 0.11 docs from the zip files-->
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>truezip-maven-plugin</artifactId>
+ <version>1.2</version>
+ <inherited>false</inherited>
+ <executions>
<execution>
- <id>get-0.9-docs</id>
+ <id>copy-0.11-documentation</id>
+ <goals>
+ <goal>copy</goal>
+ </goals>
<phase>generate-sources</phase>
+ <configuration>
+ <fileset>
+ <directory>${project.build.directory}/download/0.11.x.zip/iotdb-rel-0.11/docs/UserGuide</directory>
+ <outputDirectory>${project.build.directory}/vue-source/src/UserGuide/V0.11.x</outputDirectory>
+ </fileset>
+ </configuration>
+ </execution>
+ <execution>
+ <id>copy-0.11-zh-documentation</id>
<goals>
- <goal>wget</goal>
+ <goal>copy</goal>
</goals>
+ <phase>generate-sources</phase>
<configuration>
- <url>https://github.com/apache/iotdb/archive/rel/0.9.zip</url>
- <outputDirectory>${project.build.directory}/download</outputDirectory>
- <outputFileName>0.9.x.zip</outputFileName>
+ <fileset>
+ <directory>${project.build.directory}/download/0.11.x.zip/iotdb-rel-0.11/docs/zh/UserGuide</directory>
+ <outputDirectory>${project.build.directory}/vue-source/src/zh/UserGuide/V0.11.x</outputDirectory>
+ </fileset>
</configuration>
</execution>
+ </executions>
+ </plugin>
+ <!-- remove files if `existing` folder exist-->
+ <plugin>
+ <groupId>com.coderplus.maven.plugins</groupId>
+ <artifactId>copy-rename-maven-plugin</artifactId>
+ <version>1.0</version>
+ <executions>
<execution>
- <id>get-0.8-docs</id>
+ <id>clean-stale-0.11-doc</id>
+ <phase>compile</phase>
+ <goals>
+ <goal>rename</goal>
+ </goals>
+ <configuration>
+ <sourceFile>${project.build.directory}/existing/UserGuide/V0.11.x</sourceFile>
+ <destinationFile>${project.build.directory}/abandon/UserGuide/V0.11.x</destinationFile>
+ </configuration>
+ </execution>
+ <execution>
+ <id>clean-stale-0.11-zh-doc</id>
+ <phase>compile</phase>
+ <goals>
+ <goal>rename</goal>
+ </goals>
+ <configuration>
+ <sourceFile>${project.build.directory}/existing/zh/UserGuide/V0.11.x</sourceFile>
+ <destinationFile>${project.build.directory}/abandon/zh/UserGuide/V0.11.x</destinationFile>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ <profile>
+ <id>compile-site-0.10</id>
+ <build>
+ <plugins>
+ <!-- download 0.10 docs from iotdb repo -->
+ <plugin>
+ <groupId>com.googlecode.maven-download-plugin</groupId>
+ <artifactId>download-maven-plugin</artifactId>
+ <version>1.3.0</version>
+ <executions>
+ <execution>
+ <id>get-0.10-docs</id>
<phase>generate-sources</phase>
<goals>
<goal>wget</goal>
</goals>
<configuration>
- <url>https://github.com/apache/iotdb/archive/rel/0.8.zip</url>
+ <url>https://github.com/apache/iotdb/archive/rel/0.10.zip</url>
<outputDirectory>${project.build.directory}/download</outputDirectory>
- <outputFileName>0.8.x.zip</outputFileName>
+ <outputFileName>0.10.x.zip</outputFileName>
</configuration>
</execution>
</executions>
</plugin>
- <!-- unpack lagecy docs from the zip files-->
+ <!-- unpack 0.11 docs from the zip files-->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>truezip-maven-plugin</artifactId>
@@ -250,7 +553,7 @@
<phase>generate-sources</phase>
<configuration>
<fileset>
- <directory>${project.build.directory}/download/0.10.x.zip/incubator-iotdb-rel-0.10/docs/UserGuide</directory>
+ <directory>${project.build.directory}/download/0.10.x.zip/iotdb-rel-0.10/docs/UserGuide</directory>
<outputDirectory>${project.build.directory}/vue-source/src/UserGuide/V0.10.x</outputDirectory>
</fileset>
</configuration>
@@ -263,166 +566,224 @@
<phase>generate-sources</phase>
<configuration>
<fileset>
- <directory>${project.build.directory}/download/0.10.x.zip/incubator-iotdb-rel-0.10/docs/zh/UserGuide</directory>
+ <directory>${project.build.directory}/download/0.10.x.zip/iotdb-rel-0.10/docs/zh/UserGuide</directory>
<outputDirectory>${project.build.directory}/vue-source/src/zh/UserGuide/V0.10.x</outputDirectory>
</fileset>
</configuration>
</execution>
+ </executions>
+ </plugin>
+ <!-- remove files if `existing` folder exist-->
+ <plugin>
+ <groupId>com.coderplus.maven.plugins</groupId>
+ <artifactId>copy-rename-maven-plugin</artifactId>
+ <version>1.0</version>
+ <executions>
<execution>
- <id>copy-0.9-documentation</id>
+ <id>clean-stale-0.10-doc</id>
+ <phase>compile</phase>
<goals>
- <goal>copy</goal>
+ <goal>rename</goal>
</goals>
- <phase>generate-sources</phase>
<configuration>
- <fileset>
- <directory>${project.build.directory}/download/0.9.x.zip/incubator-iotdb-rel-0.9/docs/UserGuide</directory>
- <outputDirectory>${project.build.directory}/vue-source/src/UserGuide/V0.9.x</outputDirectory>
- </fileset>
+ <sourceFile>${project.build.directory}/existing/UserGuide/V0.10.x</sourceFile>
+ <destinationFile>${project.build.directory}/abandon/UserGuide/V0.10.x</destinationFile>
</configuration>
</execution>
<execution>
- <id>copy-0.9-zh-documentation</id>
+ <id>clean-stale-0.10-zh-doc</id>
+ <phase>compile</phase>
<goals>
- <goal>copy</goal>
+ <goal>rename</goal>
</goals>
+ <configuration>
+ <sourceFile>${project.build.directory}/existing/zh/UserGuide/V0.10.x</sourceFile>
+ <destinationFile>${project.build.directory}/abandon/zh/UserGuide/V0.10.x</destinationFile>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ <profile>
+ <id>compile-site-0.9</id>
+ <build>
+ <plugins>
+ <!-- download 0.9 docs from iotdb repo -->
+ <plugin>
+ <groupId>com.googlecode.maven-download-plugin</groupId>
+ <artifactId>download-maven-plugin</artifactId>
+ <version>1.3.0</version>
+ <executions>
+ <execution>
+ <id>get-0.9-docs</id>
<phase>generate-sources</phase>
+ <goals>
+ <goal>wget</goal>
+ </goals>
<configuration>
- <fileset>
- <directory>${project.build.directory}/download/0.9.x.zip/incubator-iotdb-rel-0.9/docs/zh/UserGuide</directory>
- <outputDirectory>${project.build.directory}/vue-source/src/zh/UserGuide/V0.9.x</outputDirectory>
- </fileset>
+ <url>https://github.com/apache/iotdb/archive/rel/0.9.zip</url>
+ <outputDirectory>${project.build.directory}/download</outputDirectory>
+ <outputFileName>0.9.x.zip</outputFileName>
</configuration>
</execution>
+ </executions>
+ </plugin>
+ <!-- unpack 0.9 docs from the zip files-->
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>truezip-maven-plugin</artifactId>
+ <version>1.2</version>
+ <inherited>false</inherited>
+ <executions>
<execution>
- <id>copy-0.8-documentation</id>
+ <id>copy-0.9-documentation</id>
<goals>
<goal>copy</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<fileset>
- <directory>${project.build.directory}/download/0.8.x.zip/incubator-iotdb-rel-0.8/docs/UserGuide</directory>
- <outputDirectory>${project.build.directory}/vue-source/src/UserGuide/V0.8.x</outputDirectory>
+ <directory>${project.build.directory}/download/0.9.x.zip/iotdb-rel-0.9/docs/UserGuide</directory>
+ <outputDirectory>${project.build.directory}/vue-source/src/UserGuide/V0.9.x</outputDirectory>
</fileset>
</configuration>
</execution>
<execution>
- <id>copy-0.8-zh-documentation</id>
+ <id>copy-0.9-zh-documentation</id>
<goals>
<goal>copy</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<fileset>
- <directory>${project.build.directory}/download/0.8.x.zip/incubator-iotdb-rel-0.8/docs/zh/UserGuide</directory>
- <outputDirectory>${project.build.directory}/vue-source/src/zh/UserGuide/V0.8.x</outputDirectory>
+ <directory>${project.build.directory}/download/0.9.x.zip/iotdb-rel-0.9/docs/zh/UserGuide</directory>
+ <outputDirectory>${project.build.directory}/vue-source/src/zh/UserGuide/V0.9.x</outputDirectory>
</fileset>
</configuration>
</execution>
</executions>
</plugin>
- <!-- mv UserGuide of master back -->
+ <!-- remove files if `existing` folder exist-->
<plugin>
<groupId>com.coderplus.maven.plugins</groupId>
<artifactId>copy-rename-maven-plugin</artifactId>
<version>1.0</version>
<executions>
<execution>
- <id>mv-master-userguide-to-docs</id>
- <phase>generate-sources</phase>
+ <id>clean-stale-0.9-doc</id>
+ <phase>compile</phase>
<goals>
<goal>rename</goal>
</goals>
<configuration>
- <sourceFile>${project.build.directory}/vue-source/src/tmpUserGuide</sourceFile>
- <destinationFile>${project.build.directory}/vue-source/src/UserGuide</destinationFile>
+ <sourceFile>${project.build.directory}/existing/UserGuide/V0.9.x</sourceFile>
+ <destinationFile>${project.build.directory}/abandon/UserGuide/V0.9.x</destinationFile>
</configuration>
</execution>
<execution>
- <id>mv-master-zh-userguide-to-docs</id>
- <phase>generate-sources</phase>
+ <id>clean-stale-0.9-zh-doc</id>
+ <phase>compile</phase>
<goals>
<goal>rename</goal>
</goals>
<configuration>
- <sourceFile>${project.build.directory}/vue-source/src/zh/tmpUserGuide</sourceFile>
- <destinationFile>${project.build.directory}/vue-source/src/zh/UserGuide</destinationFile>
+ <sourceFile>${project.build.directory}/existing/zh/UserGuide/V0.9.x</sourceFile>
+ <destinationFile>${project.build.directory}/abandon/zh/UserGuide/V0.9.x</destinationFile>
</configuration>
</execution>
</executions>
</plugin>
- <!--install node and npm， then run `npm install` and `npm run build`-->
+ </plugins>
+ </build>
+ </profile>
+ <profile>
+ <id>compile-site-0.8</id>
+ <build>
+ <plugins>
+ <!-- download 0.8 docs from iotdb repo -->
<plugin>
- <groupId>com.github.eirslett</groupId>
- <artifactId>frontend-maven-plugin</artifactId>
- <version>1.9.1</version>
- <configuration>
- <installDirectory>${project.build.directory}/tools</installDirectory>
- <workingDirectory>${project.build.directory}/vue-source</workingDirectory>
- </configuration>
+ <groupId>com.googlecode.maven-download-plugin</groupId>
+ <artifactId>download-maven-plugin</artifactId>
+ <version>1.3.0</version>
<executions>
<execution>
- <id>install-node-and-npm</id>
+ <id>get-0.8-docs</id>
+ <phase>generate-sources</phase>
<goals>
- <goal>install-node-and-npm</goal>
+ <goal>wget</goal>
</goals>
- <phase>package</phase>
<configuration>
- <nodeVersion>v12.16.2</nodeVersion>
- <npmVersion>6.14.4</npmVersion>
+ <url>https://github.com/apache/iotdb/archive/rel/0.8.zip</url>
+ <outputDirectory>${project.build.directory}/download</outputDirectory>
+ <outputFileName>0.8.x.zip</outputFileName>
</configuration>
</execution>
- <!-- Install all project dependencies -->
+ </executions>
+ </plugin>
+ <!-- unpack 0.8 docs from the zip files-->
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>truezip-maven-plugin</artifactId>
+ <version>1.2</version>
+ <inherited>false</inherited>
+ <executions>
<execution>
- <id>npm install</id>
+ <id>copy-0.8-documentation</id>
<goals>
- <goal>npm</goal>
+ <goal>copy</goal>
</goals>
- <!-- optional: default phase is "generate-resources" -->
- <phase>package</phase>
- <!-- Optional configuration which provides for running any npm command -->
+ <phase>generate-sources</phase>
<configuration>
- <arguments>install</arguments>
+ <fileset>
+ <directory>${project.build.directory}/download/0.8.x.zip/iotdb-rel-0.8/docs/UserGuide</directory>
+ <outputDirectory>${project.build.directory}/vue-source/src/UserGuide/V0.8.x</outputDirectory>
+ </fileset>
</configuration>
</execution>
- <!-- Build and minify static files -->
<execution>
- <id>npm run build</id>
- <phase>package</phase>
+ <id>copy-0.8-zh-documentation</id>
<goals>
- <goal>npm</goal>
+ <goal>copy</goal>
</goals>
+ <phase>generate-sources</phase>
<configuration>
- <arguments>run build</arguments>
+ <fileset>
+ <directory>${project.build.directory}/download/0.8.x.zip/iotdb-rel-0.8/docs/zh/UserGuide</directory>
+ <outputDirectory>${project.build.directory}/vue-source/src/zh/UserGuide/V0.8.x</outputDirectory>
+ </fileset>
</configuration>
</execution>
</executions>
</plugin>
+ <!-- remove files if `existing` folder exist-->
<plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-scm-publish-plugin</artifactId>
- <configuration>
- <!-- mono-module doesn't require site:stage -->
- <content>${project.build.directory}/vue-source/src/.vuepress/dist</content>
- <!-- branch where to deploy -->
- <scmBranch>asf-site</scmBranch>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.simplify4u.plugins</groupId>
- <artifactId>sitemapxml-maven-plugin</artifactId>
- <version>2.0.0</version>
- <configuration>
- <siteOutputDirectory>${project.build.directory}/vue-source/src/.vuepress/dist</siteOutputDirectory>
- <maxDepth>5</maxDepth>
- </configuration>
+ <groupId>com.coderplus.maven.plugins</groupId>
+ <artifactId>copy-rename-maven-plugin</artifactId>
+ <version>1.0</version>
<executions>
<execution>
- <phase>package</phase>
+ <id>clean-stale-0.8-doc</id>
+ <phase>compile</phase>
<goals>
- <goal>gen</goal>
+ <goal>rename</goal>
</goals>
+ <configuration>
+ <sourceFile>${project.build.directory}/existing/UserGuide/V0.8.x</sourceFile>
+ <destinationFile>${project.build.directory}/abandon/UserGuide/V0.8.x</destinationFile>
+ </configuration>
+ </execution>
+ <execution>
+ <id>clean-stale-0.8-zh-doc</id>
+ <phase>compile</phase>
+ <goals>
+ <goal>rename</goal>
+ </goals>
+ <configuration>
+ <sourceFile>${project.build.directory}/existing/zh/UserGuide/V0.8.x</sourceFile>
+ <destinationFile>${project.build.directory}/abandon/zh/UserGuide/V0.8.x</destinationFile>
+ </configuration>
</execution>
</executions>
</plugin>
diff --git a/site/src/main/.vuepress/config.js b/site/src/main/.vuepress/config.js
index c138e1d..32cce07 100644
--- a/site/src/main/.vuepress/config.js
+++ b/site/src/main/.vuepress/config.js
@@ -73,6 +73,7 @@ var config = {
text: 'Document',
items: [
{ text: 'In progress', link: '/UserGuide/Master/Get Started/QuickStart' },
+ { text: 'V0.11.x', link: '/UserGuide/V0.11.x/Get Started/QuickStart' },
{ text: 'V0.10.x', link: '/UserGuide/V0.10.x/Get Started/QuickStart' },
{ text: 'V0.9.x', link: '/UserGuide/V0.9.x/0-Get Started/1-QuickStart' },
{ text: 'V0.8.x', link: '/UserGuide/V0.8.x/0-Get Started/1-QuickStart'},
@@ -394,6 +395,198 @@ var config = {
]
},
],
+ '/UserGuide/V0.10.x/': [
+ {
+ title:'IoTDB User Guide (V0.10.x)',
+ collapsable: false,
+ },
+ {
+ title: 'Get Started',
+ children: [
+ ['Get Started/QuickStart','QuickStart'],
+ ['Get Started/Frequently asked questions','Frequently asked questions'],
+ ['Get Started/Publication','Research Papers']
+ ]
+ },
+ {
+ title: 'Overview',
+ children: [
+ ['Overview/What is IoTDB','What is IoTDB'],
+ ['Overview/Architecture','Architecture'],
+ ['Overview/Scenario','Scenario'],
+ ['Overview/Features','Features']
+ ]
+ },
+ {
+ title: 'Concept',
+ children: [
+ ['Concept/Data Model and Terminology','Data Model and Terminology'],
+ ['Concept/Data Type','Data Type'],
+ ['Concept/Encoding','Encoding'],
+ ['Concept/Compression','Compression']
+ ]
+ },
+ {
+ title: 'Server',
+ children: [
+ ['Server/Download','Download'],
+ ['Server/Single Node Setup','Single Node Setup'],
+ ['Server/Cluster Setup','Cluster Setup'],
+ ['Server/Config Manual','Config Manual'],
+ ['Server/Docker Image','Docker Image']
+ ]
+ },
+ {
+ title: 'Client',
+ children: [
+ ['Client/Command Line Interface','Command Line Interface'],
+ ['Client/Programming - Native API','Native API'],
+ ['Client/Programming - JDBC','JDBC'],
+ ['Client/Programming - Other Languages','Other Languages'],
+ ['Client/Programming - TsFile API','TsFile API'],
+ ['Client/Programming - MQTT','MQTT'],
+ ['Client/Status Codes','Status Codes']
+ ]
+ },
+ {
+ title: 'Operation Manual',
+ children: [
+ ['Operation Manual/DDL Data Definition Language','DDL (Data Definition Language)'],
+ ['Operation Manual/DML Data Manipulation Language','DML (Data Manipulation Language)'],
+ ['Operation Manual/Administration','Administration'],
+ ['Operation Manual/SQL Reference','SQL Reference']
+ ]
+ },
+ {
+ title: 'System Tools',
+ children: [
+ ['System Tools/Sync Tool','Sync Tool'],
+ ['System Tools/Memory Estimation Tool','Memory Estimation Tool'],
+ ['System Tools/JMX Tool','JMX Tool'],
+ ['System Tools/Watermark Tool','Watermark Tool'],
+ ['System Tools/Query History Visualization Tool','Query History Visualization Tool'],
+ ['System Tools/Monitor and Log Tools','Monitor and Log Tools'],
+ ['System Tools/Load External Tsfile','Load External Tsfile']
+ ]
+ },
+ {
+ title: 'Ecosystem Integration',
+ children: [
+ ['Ecosystem Integration/Grafana','Grafana'],
+ ['Ecosystem Integration/MapReduce TsFile','MapReduce TsFile'],
+ ['Ecosystem Integration/Spark TsFile','Spark TsFile'],
+ ['Ecosystem Integration/Spark IoTDB','Spark IoTDB'],
+ ['Ecosystem Integration/Hive TsFile','Hive TsFile']
+ ]
+ },
+ {
+ title: 'Architecture',
+ children: [
+ ['Architecture/Files','Files'],
+ ['Architecture/Writing Data on HDFS','Writing Data on HDFS'],
+ ['Architecture/Shared Nothing Cluster','Shared Nothing Cluster']
+ ]
+ },
+ ],
+ '/UserGuide/V0.11.x/': [
+ {
+ title:'IoTDB User Guide (V0.10.x)',
+ collapsable: false,
+ },
+ {
+ title: 'Get Started',
+ children: [
+ ['Get Started/QuickStart','QuickStart'],
+ ['Get Started/Frequently asked questions','Frequently asked questions'],
+ ['Get Started/Publication','Research Papers']
+ ]
+ },
+ {
+ title: 'Overview',
+ children: [
+ ['Overview/What is IoTDB','What is IoTDB'],
+ ['Overview/Architecture','Architecture'],
+ ['Overview/Scenario','Scenario'],
+ ['Overview/Features','Features']
+ ]
+ },
+ {
+ title: 'Concept',
+ children: [
+ ['Concept/Data Model and Terminology','Data Model and Terminology'],
+ ['Concept/Data Type','Data Type'],
+ ['Concept/Encoding','Encoding'],
+ ['Concept/Compression','Compression']
+ ]
+ },
+ {
+ title: 'Server',
+ children: [
+ ['Server/Download','Download'],
+ ['Server/Single Node Setup','Single Node Setup'],
+ ['Server/Cluster Setup','Cluster Setup'],
+ ['Server/Config Manual','Config Manual'],
+ ['Server/Docker Image','Docker Image']
+ ]
+ },
+ {
+ title: 'Client',
+ children: [
+ ['Client/Command Line Interface','Command Line Interface'],
+ ['Client/Programming - Native API','Native API'],
+ ['Client/Programming - JDBC','JDBC'],
+ ['Client/Programming - Other Languages','Other Languages'],
+ ['Client/Programming - TsFile API','TsFile API'],
+ ['Client/Programming - MQTT','MQTT'],
+ ['Client/Status Codes','Status Codes']
+ ]
+ },
+ {
+ title: 'Operation Manual',
+ children: [
+ ['Operation Manual/DDL Data Definition Language','DDL (Data Definition Language)'],
+ ['Operation Manual/DML Data Manipulation Language','DML (Data Manipulation Language)'],
+ ['Operation Manual/Administration','Administration'],
+ ['Operation Manual/SQL Reference','SQL Reference']
+ ]
+ },
+ {
+ title: 'System Tools',
+ children: [
+ ['System Tools/Sync Tool','Sync Tool'],
+ ['System Tools/JMX Tool','JMX Tool'],
+ ['System Tools/Watermark Tool','Watermark Tool'],
+ ['System Tools/Query History Visualization Tool','Query History Visualization Tool'],
+ ['System Tools/Monitor and Log Tools','Monitor and Log Tools'],
+ ['System Tools/Load External Tsfile','Load External Tsfile'],
+ ['System Tools/Performance Tracing Tool','Performance Tracing Tool']
+ ]
+ },
+ {
+ title: 'Ecosystem Integration',
+ children: [
+ ['Ecosystem Integration/Grafana','Grafana'],
+ ['Ecosystem Integration/MapReduce TsFile','MapReduce TsFile'],
+ ['Ecosystem Integration/Spark TsFile','Spark TsFile'],
+ ['Ecosystem Integration/Spark IoTDB','Spark IoTDB'],
+ ['Ecosystem Integration/Hive TsFile','Hive TsFile']
+ ]
+ },
+ {
+ title: 'Architecture',
+ children: [
+ ['Architecture/Files','Files'],
+ ['Architecture/Writing Data on HDFS','Writing Data on HDFS'],
+ ['Architecture/Shared Nothing Cluster','Shared Nothing Cluster']
+ ]
+ },
+ {
+ title: 'Comparison with TSDBs',
+ children: [
+ ['Comparison/TSDB-Comparison','Comparison']
+ ]
+ }
+ ],
'/UserGuide/Master/': [
{
title:'IoTDB User Guide (In progress)',
@@ -599,7 +792,8 @@ var config = {
{
text: '文档',
items: [
- { text: 'In progress', link: '/zh/UserGuide/Master/Get Started/QuickStart' },
+ { text: 'In progress', link: '/zh/UserGuide/Master/Get Started/QuickStart' },
+ { text: 'V0.11.x', link: '/zh/UserGuide/V0.11.x/Get Started/QuickStart' },
{ text: 'V0.10.x', link: '/zh/UserGuide/V0.10.x/Get Started/QuickStart' },
{ text: 'V0.9.x', link: '/zh/UserGuide/V0.9.x/0-Get Started/1-QuickStart' },
{ text: 'V0.8.x', link: '/zh/UserGuide/V0.8.x/0-Get Started/1-QuickStart'},
@@ -914,6 +1108,184 @@ var config = {
]
}
],
+ '/zh/UserGuide/V0.11.x/': [
+ {
+ title: 'IoTDB用户手册 (V0.11.x)',
+ collapsable: false,
+ },
+ {
+ title: '开始',
+ children: [
+ ['Get Started/QuickStart','快速入门'],
+ ['Get Started/Frequently asked questions','经常问的问题'],
+ ['Get Started/Publication','调查报告']
+ ]
+ },
+ {
+ title: '概述',
+ children: [
+ ['Overview/What is IoTDB','什么是IoTDB'],
+ ['Overview/Architecture','架构'],
+ ['Overview/Scenario','场景'],
+ ['Overview/Features','特征']
+ ]
+ },
+ {
+ title: '概念',
+ children: [
+ ['Concept/Data Model and Terminology','数据模型与技术'],
+ ['Concept/Data Type','数据类型'],
+ ['Concept/Encoding','编码方式'],
+ ['Concept/Compression','压缩方式']
+ ]
+ },
+ {
+ title: '服务器端',
+ children: [
+ ['Server/Download','下载'],
+ ['Server/Single Node Setup','单节点安装'],
+ ['Server/Cluster Setup','集群设置'],
+ ['Server/Config Manual','配置手册'],
+ ['Server/Docker Image','Docker镜像']
+ ]
+ },
+ {
+ title: '客户端',
+ children: [
+ ['Client/Command Line Interface','命令行接口(CLI)'],
+ ['Client/Programming - Native API','原生接口'],
+ ['Client/Programming - JDBC','JDBC'],
+ ['Client/Programming - Other Languages','其他语言'],
+ ['Client/Programming - TsFile API','TsFile API'],
+ ['Client/Programming - MQTT','MQTT'],
+ ['Client/Status Codes','状态码']
+ ]
+ },
+ {
+ title: '操作指南',
+ children: [
+ ['Operation Manual/DDL Data Definition Language','DDL (数据定义语言)'],
+ ['Operation Manual/DML Data Manipulation Language','DML (数据操作语言)'],
+ ['Operation Manual/Administration','权限管理语句'],
+ ['Operation Manual/SQL Reference','SQL 参考文档']
+ ]
+ },
+ {
+ title: '系统工具',
+ children: [
+ ['System Tools/Sync Tool','同步工具'],
+ ['System Tools/JMX Tool','JMX工具'],
+ ['System Tools/Watermark Tool','水印工具'],
+ ['System Tools/Query History Visualization Tool','查询历史可视化工具'],
+ ['System Tools/Monitor and Log Tools','监控与日志工具'],
+ ['System Tools/Load External Tsfile','加载外部tsfile文件'],
+ ['System Tools/Performance Tracing Tool','性能追踪工具']
+ ]
+ },
+ {
+ title: '生态集成',
+ children: [
+ ['Ecosystem Integration/Grafana','Grafana'],
+ ['Ecosystem Integration/MapReduce TsFile','MapReduce TsFile'],
+ ['Ecosystem Integration/Spark TsFile','Spark TsFile'],
+ ['Ecosystem Integration/Spark IoTDB','Spark IoTDB'],
+ ['Ecosystem Integration/Hive TsFile','Hive TsFile']
+ ]
+ },
+ {
+ title: '系统设计',
+ children: [
+ ['Architecture/Files','文件'],
+ ['Architecture/Writing Data on HDFS','使用HDFS存储数据'],
+ ['Architecture/Shared Nothing Cluster','Shared-nothing 架构']
+ ]
+ }
+ ],
+ '/zh/SystemDesign/': [
+ {
+ title: '系统设计',
+ collapsable: false,
+ },
+ {
+ title: '应用概览',
+ children: [
+ ['Architecture/Architecture','应用概览']
+ ]
+ },
+ {
+ title: 'TsFile',
+ children: [
+ ['TsFile/TsFile','TsFile'],
+ ['TsFile/Format','格式'],
+ ['TsFile/Write','写流程'],
+ ['TsFile/Read','读流程']
+ ]
+ },
+ {
+ title: '查询引擎',
+ children: [
+ ['QueryEngine/QueryEngine','查询引擎'],
+ ['QueryEngine/Planner','执行计划生成器'],
+ ['QueryEngine/PlanExecutor','计划执行器'],
+ ['QueryEngine/ResultSetConstruction','结果集构造']
+ ]
+ },
+ {
+ title: '元数据管理',
+ children: [
+ ['SchemaManager/SchemaManager','元数据管理']
+ ]
+ },
+ {
+ title: '存储引擎',
+ children: [
+ ['StorageEngine/FileLists','磁盘文件汇总'],
+ ['StorageEngine/StorageEngine','存储引擎'],
+ ['StorageEngine/WAL','写前日志'],
+ ['StorageEngine/FlushManager','FlushManager'],
+ ['StorageEngine/MergeManager','文件合并机制'],
+ ['StorageEngine/DataPartition','数据分区'],
+ ['StorageEngine/DataManipulation','数据增删改'],
+ ['StorageEngine/Recover','重启恢复'],
+ ]
+ },
+ {
+ title: '数据查询',
+ children: [
+ ['DataQuery/DataQuery','数据查询'],
+ ['DataQuery/QueryFundamentals','查询基础介绍'],
+ ['DataQuery/SeriesReader','查询基础组件'],
+ ['DataQuery/RawDataQuery','原始数据查询'],
+ ['DataQuery/AggregationQuery','聚合查询'],
+ ['DataQuery/GroupByQuery','降采样查询'],
+ ['DataQuery/LastQuery','最近时间戳 Last 查询'],
+ ['DataQuery/AlignByDeviceQuery','按设备对齐查询'],
+ ['DataQuery/FillFunction','空值填充'],
+ ['DataQuery/GroupByFillQuery', '降采样补空值查询'],
+ ['DataQuery/OrderByTimeQuery', '按时间倒序查询']
+ ]
+ },
+ {
+ title: '工具',
+ children: [
+ ['Tools/Sync','同步工具']
+ ]
+ },
+ {
+ title: '连接器',
+ children: [
+ ['Connector/Hive-TsFile','Hive-TsFile'],
+ ['Connector/Spark-TsFile','Spark-TsFile'],
+ ['Connector/Spark-IOTDB','Spark-IOTDB']
+ ]
+ },
+ {
+ title: '客户端',
+ children: [
+ ['Client/RPC','RPC']
+ ]
+ },
+ ],
'/zh/UserGuide/Master/': [
{
title: 'IoTDB用户手册 (In progress)',
diff --git a/site/src/main/package.json b/site/src/main/package.json
index ce97f7f..b6a23d2 100644
--- a/site/src/main/package.json
+++ b/site/src/main/package.json
@@ -4,9 +4,9 @@
"description": "Apache IoTDB Website",
"main": "index.js",
"scripts": {
- "dev": "node --max_old_space_size=8000 ./node_modules/vuepress/cli.js dev src",
- "build": "node --max_old_space_size=8000 ./node_modules/vuepress/cli.js build src",
- "deploy": "node --max_old_space_size=8000 deploy.js"
+ "dev": "node --max_old_space_size=4000 ./node_modules/vuepress/cli.js dev src",
+ "build": "node --max_old_space_size=4000 ./node_modules/vuepress/cli.js build src",
+ "deploy": "node --max_old_space_size=4000 deploy.js"
},
"repository": {
"type": "git",