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/03 18:36:08 UTC
[iotdb] 01/01: add 0.11 documents on website
This is an automated email from the ASF dual-hosted git repository.
hxd pushed a commit to branch for_0.11_web
in repository https://gitbox.apache.org/repos/asf/iotdb.git
commit aee59ba98dcb1058396dcd68137c2977e9d808e2
Author: xiangdong huang <sa...@gmail.com>
AuthorDate: Wed Nov 4 02:24:30 2020 +0800
add 0.11 documents on website
---
site/pom.xml | 38 ++++++++
site/src/main/.vuepress/config.js | 199 +++++++++++++++++++++++++++++++++++++-
2 files changed, 235 insertions(+), 2 deletions(-)
diff --git a/site/pom.xml b/site/pom.xml
index 9d2bb03..58b3a8d 100644
--- a/site/pom.xml
+++ b/site/pom.xml
@@ -195,6 +195,18 @@
<version>1.3.0</version>
<executions>
<execution>
+ <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.11.zip</url>
+ <outputDirectory>${project.build.directory}/download</outputDirectory>
+ <outputFileName>0.11.x.zip</outputFileName>
+ </configuration>
+ </execution>
+ <execution>
<id>get-0.10-docs</id>
<phase>generate-sources</phase>
<goals>
@@ -240,6 +252,32 @@
<inherited>false</inherited>
<executions>
<execution>
+ <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>copy</goal>
+ </goals>
+ <phase>generate-sources</phase>
+ <configuration>
+ <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>
+ <execution>
<id>copy-0.10-documentation</id>
<goals>
<goal>copy</goal>
diff --git a/site/src/main/.vuepress/config.js b/site/src/main/.vuepress/config.js
index e1c6c8a..9c25140 100644
--- a/site/src/main/.vuepress/config.js
+++ b/site/src/main/.vuepress/config.js
@@ -20,7 +20,7 @@ var config = {
head: [
['link', { rel: 'icon', href: '/favicon.ico' }],
["meta", {name: "Description", content: "Apache IoTDB: Time Series Database for IoT"}],
- ["meta", {name: "Keywords", content: "TSDB, time series, time series database, IoTDB, IoT database, IoT data management,时序数据库, 时间序列管理, IoTDB, 物联网数据库, 实时数据库, 物联网数据管理, 物联网数据"}],
+ ["meta", {name: "Keywords", content: "TSDB, time series, time series database, IoTDB, IoT database, IoT data management,时序数据库, 时间序列管理, Apache IoTDB, 物联网数据库, 实时数据库, 物联网数据管理, 物联网数据"}],
["meta", {name: "baidu-site-verification", content: "wfKETzB3OT"}],
["meta", {name: "google-site-verification", content: "mZWAoRY0yj_HAr-s47zHCGHzx5Ju-RVm5wDbPnwQYFo"}],
],
@@ -29,7 +29,7 @@ var config = {
base: '',
// 网站标题
- title: 'IoTDB Website',
+ title: 'Apache IoTDB',
// <meta name="description" content="...">
description: 'Apache IoTDB',
@@ -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'},
@@ -111,6 +112,7 @@ var config = {
text: 'Blog',
items: [
{ text: 'Overview', link: '/Blog/Index'},
+ { text: 'Apache IoTDB Graduated as Top Level Project', link: 'https://blogs.apache.org/foundation/entry/the-apache-software-foundation-announces68'},
{ text: 'Some Notes on Release 0.9.3 and upcoming 0.10.0', link: '/Blog/Release0_93'}
]
},
@@ -394,6 +396,105 @@ var config = {
]
},
],
+ '/UserGuide/V0.11.x/': [
+ {
+ title:'IoTDB User Guide (V0.11.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)',
@@ -600,6 +701,7 @@ var config = {
text: '文档',
items: [
{ 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 +1016,99 @@ 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/Memory Estimation 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文件']
+ ]
+ },
+ {
+ 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/UserGuide/Master/': [
{
title: 'IoTDB用户手册 (In progress)',