This is an automated email from the ASF dual-hosted git repository. haonan pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
commit 2e9767816856efdb2f4476fdf799d862990c696f Author: CritasWang <[email protected]> AuthorDate: Wed Jul 12 16:32:01 2023 +0800 feat(1.2): 1. add 1.2 2. add sidebar_timechp --- src/.vuepress/config.ts | 4 +- src/.vuepress/navbar/en.ts | 2 +- src/.vuepress/navbar/zh.ts | 2 +- src/.vuepress/{navbar => navbar_timecho}/en.ts | 2 +- src/.vuepress/{utils => navbar_timecho}/index.ts | 8 +- src/.vuepress/{navbar => navbar_timecho}/zh.ts | 2 +- src/.vuepress/sidebar/en.ts | 8 +- src/.vuepress/sidebar/zh.ts | 326 ++++++++++----------- src/.vuepress/sidebar_timecho/V0.13.x/en.ts | 215 ++++++++++++++ src/.vuepress/sidebar_timecho/V0.13.x/zh.ts | 223 ++++++++++++++ src/.vuepress/sidebar_timecho/V1.0.x/en.ts | 285 ++++++++++++++++++ src/.vuepress/sidebar_timecho/V1.0.x/zh.ts | 289 ++++++++++++++++++ src/.vuepress/sidebar_timecho/V1.1.x/en.ts | 306 +++++++++++++++++++ src/.vuepress/sidebar_timecho/V1.1.x/zh.ts | 175 +++++++++++ .../{utils/index.ts => sidebar_timecho/en.ts} | 14 +- src/.vuepress/{utils => sidebar_timecho}/index.ts | 8 +- .../{utils/index.ts => sidebar_timecho/zh.ts} | 14 +- src/.vuepress/styles/index.scss | 3 + src/.vuepress/utils/index.ts | 4 +- 19 files changed, 1693 insertions(+), 197 deletions(-) diff --git a/src/.vuepress/config.ts b/src/.vuepress/config.ts index 4ebd9aa..df36afb 100644 --- a/src/.vuepress/config.ts +++ b/src/.vuepress/config.ts @@ -114,8 +114,8 @@ export default defineUserConfig({ redirectPlugin({ // hostname: 'https://iotdb.apache.org/', config: { - '/UserGuide/Master/QuickStart/QuickStart.html': '/UserGuide/V1.1.x/QuickStart/QuickStart.html', - '/zh/UserGuide/Master/QuickStart/QuickStart.html': '/zh/UserGuide/V1.1.x/QuickStart/QuickStart.html', + '/UserGuide/Master/QuickStart/QuickStart.html': '/UserGuide/V1.2.x/QuickStart/QuickStart.html', + '/zh/UserGuide/Master/QuickStart/QuickStart.html': '/zh/UserGuide/V1.2.x/QuickStart/QuickStart.html', }, }), googleAnalyticsPlugin({ diff --git a/src/.vuepress/navbar/en.ts b/src/.vuepress/navbar/en.ts index 7c7612a..10c43dc 100644 --- a/src/.vuepress/navbar/en.ts +++ b/src/.vuepress/navbar/en.ts @@ -24,7 +24,7 @@ export const enNavbar = navbar([ text: 'Documentation', children: [ // { text: 'latest', link: '/UserGuide/Master/QuickStart/QuickStart' }, - // { text: 'v1.2.x', link: '/UserGuide/V1.2.x/QuickStart/QuickStart' }, + { text: 'v1.2.x', link: '/UserGuide/V1.2.x/QuickStart/QuickStart' }, { text: 'v1.1.x', link: '/UserGuide/V1.1.x/QuickStart/QuickStart' }, { text: 'v1.0.x', link: '/UserGuide/V1.0.x/QuickStart/QuickStart' }, { text: 'v0.13.x', link: '/UserGuide/V0.13.x/QuickStart/QuickStart' }, diff --git a/src/.vuepress/navbar/zh.ts b/src/.vuepress/navbar/zh.ts index aa2eae9..895eb96 100644 --- a/src/.vuepress/navbar/zh.ts +++ b/src/.vuepress/navbar/zh.ts @@ -24,7 +24,7 @@ export const zhNavbar = navbar([ text: '文档', children: [ // { text: 'latest', link: '/zh/UserGuide/Master/QuickStart/QuickStart' }, - // { text: 'v1.2.x', link: '/zh/UserGuide/V1.2.x/QuickStart/QuickStart' }, + { text: 'v1.2.x', link: '/zh/UserGuide/V1.2.x/QuickStart/QuickStart' }, { text: 'v1.1.x', link: '/zh/UserGuide/V1.1.x/QuickStart/QuickStart' }, { text: 'v1.0.x', link: '/zh/UserGuide/V1.0.x/QuickStart/QuickStart' }, { text: 'v0.13.x', link: '/zh/UserGuide/V0.13.x/QuickStart/QuickStart' }, diff --git a/src/.vuepress/navbar/en.ts b/src/.vuepress/navbar_timecho/en.ts similarity index 97% copy from src/.vuepress/navbar/en.ts copy to src/.vuepress/navbar_timecho/en.ts index 7c7612a..10c43dc 100644 --- a/src/.vuepress/navbar/en.ts +++ b/src/.vuepress/navbar_timecho/en.ts @@ -24,7 +24,7 @@ export const enNavbar = navbar([ text: 'Documentation', children: [ // { text: 'latest', link: '/UserGuide/Master/QuickStart/QuickStart' }, - // { text: 'v1.2.x', link: '/UserGuide/V1.2.x/QuickStart/QuickStart' }, + { text: 'v1.2.x', link: '/UserGuide/V1.2.x/QuickStart/QuickStart' }, { text: 'v1.1.x', link: '/UserGuide/V1.1.x/QuickStart/QuickStart' }, { text: 'v1.0.x', link: '/UserGuide/V1.0.x/QuickStart/QuickStart' }, { text: 'v0.13.x', link: '/UserGuide/V0.13.x/QuickStart/QuickStart' }, diff --git a/src/.vuepress/utils/index.ts b/src/.vuepress/navbar_timecho/index.ts similarity index 82% copy from src/.vuepress/utils/index.ts copy to src/.vuepress/navbar_timecho/index.ts index 002eff5..4493c7e 100644 --- a/src/.vuepress/utils/index.ts +++ b/src/.vuepress/navbar_timecho/index.ts @@ -17,9 +17,5 @@ under the License. */ -export * from './define.js'; -export * from './editLink.js'; -export * from './typings.js'; - -export const defaultVersion = 'V1.1.x'; -export const defaultBranch = 'rel/1.1'; +export * from './en.js'; +export * from './zh.js'; diff --git a/src/.vuepress/navbar/zh.ts b/src/.vuepress/navbar_timecho/zh.ts similarity index 97% copy from src/.vuepress/navbar/zh.ts copy to src/.vuepress/navbar_timecho/zh.ts index aa2eae9..895eb96 100644 --- a/src/.vuepress/navbar/zh.ts +++ b/src/.vuepress/navbar_timecho/zh.ts @@ -24,7 +24,7 @@ export const zhNavbar = navbar([ text: '文档', children: [ // { text: 'latest', link: '/zh/UserGuide/Master/QuickStart/QuickStart' }, - // { text: 'v1.2.x', link: '/zh/UserGuide/V1.2.x/QuickStart/QuickStart' }, + { text: 'v1.2.x', link: '/zh/UserGuide/V1.2.x/QuickStart/QuickStart' }, { text: 'v1.1.x', link: '/zh/UserGuide/V1.1.x/QuickStart/QuickStart' }, { text: 'v1.0.x', link: '/zh/UserGuide/V1.0.x/QuickStart/QuickStart' }, { text: 'v0.13.x', link: '/zh/UserGuide/V0.13.x/QuickStart/QuickStart' }, diff --git a/src/.vuepress/sidebar/en.ts b/src/.vuepress/sidebar/en.ts index c64aa67..f697f4a 100644 --- a/src/.vuepress/sidebar/en.ts +++ b/src/.vuepress/sidebar/en.ts @@ -24,6 +24,10 @@ import { enSidebar as V100xSidebar } from './V1.0.x/en.js'; import { enSidebar as V013xSidebar } from './V0.13.x/en.js'; export const enSidebar = sidebar({ + ...V102xSidebar, + ...V101xSidebar, + ...V100xSidebar, + ...V013xSidebar, // '/UserGuide/Master/': [ // { // text: 'IoTDB User Guide (latest)', @@ -300,8 +304,4 @@ export const enSidebar = sidebar({ // ], // }, // ], - // ...V102xSidebar, - ...V101xSidebar, - ...V100xSidebar, - ...V013xSidebar, }); diff --git a/src/.vuepress/sidebar/zh.ts b/src/.vuepress/sidebar/zh.ts index 2ddb687..d23deba 100644 --- a/src/.vuepress/sidebar/zh.ts +++ b/src/.vuepress/sidebar/zh.ts @@ -23,165 +23,169 @@ import { zhSidebar as V101xSidebar } from './V1.1.x/zh.js'; import { zhSidebar as V100xSidebar } from './V1.0.x/zh.js'; import { zhSidebar as V013xSidebar } from './V0.13.x/zh.js'; - export const zhSidebar = sidebar({ -// '/zh/UserGuide/Master/': [ -// { -// text: 'IoTDB用户手册 (In progress)', -// children: [], -// }, -// { -// text: '关于IoTDB', -// collapsible: true, -// prefix: 'IoTDB-Introduction/', -// // children: 'structure', 使用该方式自动获取文件夹下的文件 -// children: [ -// { text: 'IoTDB简介', link: 'What-is-IoTDB' }, -// { text: '主要功能特点', link: 'Features' }, -// { text: '系统架构', link: 'Architecture' }, -// { text: '应用场景', link: 'Scenario' }, -// { text: '研究论文', link: 'Publication' }, -// ], -// }, -// { -// text: '快速上手', -// collapsible: true, -// prefix: 'QuickStart/', -// // children: 'structure', -// children: [ -// { text: '快速上手', link: 'QuickStart' }, -// { text: '集群快速上手', link: 'ClusterQuickStart' }, -// { text: '下载与安装', link: 'WayToGetIoTDB' }, -// { text: 'SQL命令行终端(CLI)', link: 'Command-Line-Interface' }, -// { text: '数据文件存储', link: 'Files' }, -// ], -// }, -// { -// text: '数据模式与概念', -// collapsible: true, -// prefix: 'Data-Concept/', -// // children: 'structure', -// children: [ -// { text: '数据模型', link: 'Data-Model-and-Terminology' }, -// { text: '元数据模板', link: 'Schema-Template' }, -// { text: '数据类型', link: 'Data-Type' }, -// { text: '死区处理', link: 'Deadband-Process' }, -// { text: '编码方式', link: 'Encoding' }, -// { text: '压缩方式', link: 'Compression' }, -// { text: '数据的时间分区', link: 'Time-Partition' }, -// { text: '时区', link: 'Time-zone' }, -// ], -// }, -// { -// text: '语法约定', -// collapsible: true, -// prefix: 'Syntax-Conventions/', -// // children: 'structure', -// children: [ -// { text: '字面值常量', link: 'Literal-Values' }, -// { text: '标识符', link: 'Identifier' }, -// { text: '路径结点名', link: 'NodeName-In-Path' }, -// { text: '键值对', link: 'KeyValue-Pair' }, -// { text: '关键字', link: 'Keywords-And-Reserved-Words' }, -// { text: 'Session And TsFile API', link: 'Session-And-TsFile-API' }, -// { text: '词法和文法详细定义', link: 'Detailed-Grammar' }, -// ], -// }, -// { -// text: '应用编程接口', -// collapsible: true, -// prefix: 'API/', -// // children: 'structure', -// children: [ -// { text: 'Java 原生接口', link: 'Programming-Java-Native-API' }, -// { text: 'Python 原生接口', link: 'Programming-Python-Native-API' }, -// { text: 'C++ 原生接口', link: 'Programming-Cpp-Native-API' }, -// { text: 'Go 原生接口', link: 'Programming-Go-Native-API' }, -// { text: 'JDBC (不推荐)', link: 'Programming-JDBC' }, -// { text: 'MQTT', link: 'Programming-MQTT' }, -// { text: 'REST API V1 (不推荐)', link: 'RestServiceV1' }, -// { text: 'REST API V2', link: 'RestServiceV2' }, -// { text: 'TsFile API', link: 'Programming-TsFile-API' }, -// { text: '原生接口对比', link: 'Interface-Comparison' }, -// ], -// }, -// { -// text: '元数据操作', -// collapsible: true, -// prefix: 'Operate-Metadata/', -// // children: 'structure', -// children: [ -// { text: '数据库操作', link: 'Database' }, -// { text: '节点操作', link: 'Node' }, -// { text: '时间序列操作', link: 'Timeseries' }, -// { text: '元数据模板', link: 'Template' }, -// { text: '自动创建元数据', link: 'Auto-Create-MetaData' }, -// ], -// }, -// { -// text: '数据写入（数据更新）', -// collapsible: true, -// prefix: 'Write-Data/', -// // children: 'structure', -// children: [ -// { text: 'CLI 写入数据', link: 'Write-Data' }, -// { text: '原生接口写入', link: 'Session' }, -// { text: 'REST 服务', link: 'REST-API' }, -// { text: 'MQTT 写入', link: 'MQTT' }, -// { text: '批量数据导入', link: 'Batch-Load-Tool' }, -// ], -// }, -// { -// text: '数据删除', -// collapsible: true, -// prefix: 'Delete-Data/', -// // children: 'structure', -// children: [ -// { text: '删除数据', link: 'Delete-Data' }, -// { text: 'TTL', link: 'TTL' }, -// ], -// }, -// { -// text: '数据查询', -// collapsible: true, -// prefix: 'Query-Data/', -// // children: 'structure', -// children: [ -// { text: '概述', link: 'Overview' }, -// { text: '选择表达式', link: 'Select-Expression' }, -// { text: '最新点查询', link: 'Last-Query' }, -// { text: '查询对齐模式', link: 'Align-By' }, -// { text: '查询过滤条件', link: 'Where-Condition' }, -// { text: '分段分组聚合', link: 'Group-By' }, -// { text: '聚合结果过滤', link: 'Having-Condition' }, -// { text: '结果集排序', link: 'Order-By' }, -// { text: '结果集补空值', link: 'Fill' }, -// { text: '结果集分页', link: 'Pagination' }, -// { text: '查询写回', link: 'Select-Into' }, -// { text: '连续查询', link: 'Continuous-Query' }, -// ], -// }, -// { -// text: '运算符和函数', -// collapsible: true, -// prefix: 'Operators-Functions/', -// // children: 'structure', -// children: [ -// { text: '概述', link: 'Overview' }, -// { text: '用户自定义函数', link: 'User-Defined-Function' }, -// { text: '聚合函数', link: 'Aggregation' }, -// { text: '算数运算符和函数', link: 'Mathematical' }, -// { text: '比较运算符和函数', link: 'Comparison' }, -// { text: '逻辑运算符', link: 'Logical' }, -// { text: '字符串处理', link: 'String' }, -// { text: '数据类型转换', link: 'Conversion' }, -// { text: '常序列生成', link: 'Constant' }, -// { text: '选择函数', link: 'Selection' }, -// { text: '区间查询', link: 'Continuous-Interval' }, -// { text: '趋势计算', link: 'Variation-Trend' }, -// { text: '采样函数', link: 'Sample' }, -// { text: '时间序列处理', link: 'Time-Series' }, -// { text: 'Lambda 表达式', link: 'Lambda' }, -// { text: '条件表达式', link: 'Conditional' }, +export const zhSidebar = sidebar({ + ...V102xSidebar, + ...V101xSidebar, + ...V100xSidebar, + ...V013xSidebar, + // '/zh/UserGuide/Master/': [ + // { + // text: 'IoTDB用户手册 (In progress)', + // children: [], + // }, + // { + // text: '关于IoTDB', + // collapsible: true, + // prefix: 'IoTDB-Introduction/', + // // children: 'structure', 使用该方式自动获取文件夹下的文件 + // children: [ + // { text: 'IoTDB简介', link: 'What-is-IoTDB' }, + // { text: '主要功能特点', link: 'Features' }, + // { text: '系统架构', link: 'Architecture' }, + // { text: '应用场景', link: 'Scenario' }, + // { text: '研究论文', link: 'Publication' }, + // ], + // }, + // { + // text: '快速上手', + // collapsible: true, + // prefix: 'QuickStart/', + // // children: 'structure', + // children: [ + // { text: '快速上手', link: 'QuickStart' }, + // { text: '集群快速上手', link: 'ClusterQuickStart' }, + // { text: '下载与安装', link: 'WayToGetIoTDB' }, + // { text: 'SQL命令行终端(CLI)', link: 'Command-Line-Interface' }, + // { text: '数据文件存储', link: 'Files' }, + // ], + // }, + // { + // text: '数据模式与概念', + // collapsible: true, + // prefix: 'Data-Concept/', + // // children: 'structure', + // children: [ + // { text: '数据模型', link: 'Data-Model-and-Terminology' }, + // { text: '元数据模板', link: 'Schema-Template' }, + // { text: '数据类型', link: 'Data-Type' }, + // { text: '死区处理', link: 'Deadband-Process' }, + // { text: '编码方式', link: 'Encoding' }, + // { text: '压缩方式', link: 'Compression' }, + // { text: '数据的时间分区', link: 'Time-Partition' }, + // { text: '时区', link: 'Time-zone' }, + // ], + // }, + // { + // text: '语法约定', + // collapsible: true, + // prefix: 'Syntax-Conventions/', + // // children: 'structure', + // children: [ + // { text: '字面值常量', link: 'Literal-Values' }, + // { text: '标识符', link: 'Identifier' }, + // { text: '路径结点名', link: 'NodeName-In-Path' }, + // { text: '键值对', link: 'KeyValue-Pair' }, + // { text: '关键字', link: 'Keywords-And-Reserved-Words' }, + // { text: 'Session And TsFile API', link: 'Session-And-TsFile-API' }, + // { text: '词法和文法详细定义', link: 'Detailed-Grammar' }, + // ], + // }, + // { + // text: '应用编程接口', + // collapsible: true, + // prefix: 'API/', + // // children: 'structure', + // children: [ + // { text: 'Java 原生接口', link: 'Programming-Java-Native-API' }, + // { text: 'Python 原生接口', link: 'Programming-Python-Native-API' }, + // { text: 'C++ 原生接口', link: 'Programming-Cpp-Native-API' }, + // { text: 'Go 原生接口', link: 'Programming-Go-Native-API' }, + // { text: 'JDBC (不推荐)', link: 'Programming-JDBC' }, + // { text: 'MQTT', link: 'Programming-MQTT' }, + // { text: 'REST API V1 (不推荐)', link: 'RestServiceV1' }, + // { text: 'REST API V2', link: 'RestServiceV2' }, + // { text: 'TsFile API', link: 'Programming-TsFile-API' }, + // { text: '原生接口对比', link: 'Interface-Comparison' }, + // ], + // }, + // { + // text: '元数据操作', + // collapsible: true, + // prefix: 'Operate-Metadata/', + // // children: 'structure', + // children: [ + // { text: '数据库操作', link: 'Database' }, + // { text: '节点操作', link: 'Node' }, + // { text: '时间序列操作', link: 'Timeseries' }, + // { text: '元数据模板', link: 'Template' }, + // { text: '自动创建元数据', link: 'Auto-Create-MetaData' }, + // ], + // }, + // { + // text: '数据写入（数据更新）', + // collapsible: true, + // prefix: 'Write-Data/', + // // children: 'structure', + // children: [ + // { text: 'CLI 写入数据', link: 'Write-Data' }, + // { text: '原生接口写入', link: 'Session' }, + // { text: 'REST 服务', link: 'REST-API' }, + // { text: 'MQTT 写入', link: 'MQTT' }, + // { text: '批量数据导入', link: 'Batch-Load-Tool' }, + // ], + // }, + // { + // text: '数据删除', + // collapsible: true, + // prefix: 'Delete-Data/', + // // children: 'structure', + // children: [ + // { text: '删除数据', link: 'Delete-Data' }, + // { text: 'TTL', link: 'TTL' }, + // ], + // }, + // { + // text: '数据查询', + // collapsible: true, + // prefix: 'Query-Data/', + // // children: 'structure', + // children: [ + // { text: '概述', link: 'Overview' }, + // { text: '选择表达式', link: 'Select-Expression' }, + // { text: '最新点查询', link: 'Last-Query' }, + // { text: '查询对齐模式', link: 'Align-By' }, + // { text: '查询过滤条件', link: 'Where-Condition' }, + // { text: '分段分组聚合', link: 'Group-By' }, + // { text: '聚合结果过滤', link: 'Having-Condition' }, + // { text: '结果集排序', link: 'Order-By' }, + // { text: '结果集补空值', link: 'Fill' }, + // { text: '结果集分页', link: 'Pagination' }, + // { text: '查询写回', link: 'Select-Into' }, + // { text: '连续查询', link: 'Continuous-Query' }, + // ], + // }, + // { + // text: '运算符和函数', + // collapsible: true, + // prefix: 'Operators-Functions/', + // // children: 'structure', + // children: [ + // { text: '概述', link: 'Overview' }, + // { text: '用户自定义函数', link: 'User-Defined-Function' }, + // { text: '聚合函数', link: 'Aggregation' }, + // { text: '算数运算符和函数', link: 'Mathematical' }, + // { text: '比较运算符和函数', link: 'Comparison' }, + // { text: '逻辑运算符', link: 'Logical' }, + // { text: '字符串处理', link: 'String' }, + // { text: '数据类型转换', link: 'Conversion' }, + // { text: '常序列生成', link: 'Constant' }, + // { text: '选择函数', link: 'Selection' }, + // { text: '区间查询', link: 'Continuous-Interval' }, + // { text: '趋势计算', link: 'Variation-Trend' }, + // { text: '采样函数', link: 'Sample' }, + // { text: '时间序列处理', link: 'Time-Series' }, + // { text: 'Lambda 表达式', link: 'Lambda' }, + // { text: '条件表达式', link: 'Conditional' }, // // IoTDB-Quality // { text: '数据画像', link: 'Data-Profiling' }, @@ -302,8 +306,4 @@ import { zhSidebar as V013xSidebar } from './V0.13.x/zh.js'; // ], // }, // ], -// ...V102xSidebar, - ...V101xSidebar, - ...V100xSidebar, - ...V013xSidebar, }); diff --git a/src/.vuepress/sidebar_timecho/V0.13.x/en.ts b/src/.vuepress/sidebar_timecho/V0.13.x/en.ts new file mode 100644 index 0000000..1eb4857 --- /dev/null +++ b/src/.vuepress/sidebar_timecho/V0.13.x/en.ts @@ -0,0 +1,215 @@ +/* + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +export const enSidebar = { + '/UserGuide/V0.13.x/': [ + { + text: 'IoTDB User Guide (V0.13.x)', + collapsible: false, + children: [], + }, + { + text: 'IoTDB Introduction', + collapsible: true, + prefix: 'IoTDB-Introduction/', + children: [ + { text: 'What is IoTDB', link: 'What-is-IoTDB' }, + { text: 'Architecture', link: 'Architecture' }, + { text: 'Scenario', link: 'Scenario' }, + { text: 'Features', link: 'Features' }, + { text: 'Publication', link: 'Publication' }, + ], + }, + { + text: 'Quick Start', + collapsible: true, + prefix: 'QuickStart/', + children: [ + { text: 'Quick Start', link: 'QuickStart' }, + { text: 'Data storage', link: 'Files' }, + { text: 'Download and Setup', link: 'WayToGetIoTDB' }, + { text: 'Command Line Interface', link: 'Command-Line-Interface' }, + ], + }, + { + text: 'Data Concept', + collapsible: true, + prefix: 'Data-Concept/', + children: [ + { text: 'Data Model and Terminology', link: 'Data-Model-and-Terminology' }, + { text: 'Schema Template', link: 'Schema-Template' }, + { text: 'Data Type', link: 'Data-Type' }, + { text: 'Deadband Process', link: 'Deadband-Process' }, + { text: 'Encoding', link: 'Encoding' }, + { text: 'Compression', link: 'Compression' }, + { text: 'Time Partition', link: 'Time-Partition' }, + { text: 'Time zone', link: 'Time-zone' }, + ], + }, + { + text: 'Syntax Conventions', + collapsible: true, + prefix: 'Reference/', + children: [ + { text: 'Syntax Conventions', link: 'Syntax-Conventions' }, + ], + }, + { + text: 'API', + collapsible: true, + prefix: 'API/', + children: [ + { text: 'Java Native API', link: 'Programming-Java-Native-API' }, + { text: 'Python Native API', link: 'Programming-Python-Native-API' }, + { text: 'C++ Native API', link: 'Programming-Cpp-Native-API' }, + { text: 'Go Native API', link: 'Programming-Go-Native-API' }, + { text: 'JDBC (Not Recommend)', link: 'Programming-JDBC' }, + { text: 'MQTT', link: 'Programming-MQTT' }, + { text: 'REST API', link: 'RestService' }, + { text: 'TsFile API', link: 'Programming-TsFile-API' }, + { text: 'Status Codes', link: 'Status-Codes' }, + ], + }, + { + text: 'Operate Metadata', + collapsible: true, + prefix: 'Operate-Metadata/', + children: [ + { text: 'Storage Group', link: 'Storage-Group' }, + { text: 'Node', link: 'Node' }, + { text: 'Timeseries', link: 'Timeseries' }, + { text: 'Schema Template', link: 'Template' }, + { text: 'TTL', link: 'TTL' }, + { text: 'Auto Create Metadata', link: 'Auto-Create-MetaData' }, + ], + }, + { + text: 'Write and Delete Data', + collapsible: true, + prefix: 'Write-And-Delete-Data/', + children: [ + { text: 'Write Data', link: 'Write-Data' }, + { text: 'Load External Tsfile', link: 'Load-External-Tsfile' }, + { text: 'CSV Tool', link: 'CSV-Tool' }, + { text: 'Delete Data', link: 'Delete-Data' }, + ], + }, + { + text: 'Query Data', + collapsible: true, + prefix: 'Query-Data/', + children: [ + { text: 'Overview', link: 'Overview' }, + { text: 'Select Expression', link: 'Select-Expression' }, + { text: 'Query Filter', link: 'Query-Filter' }, + { text: 'Pagination', link: 'Pagination' }, + { text: 'Query Result Formats', link: 'Result-Format' }, + { text: 'Aggregate Query', link: 'Aggregate-Query' }, + { text: 'Last Query', link: 'Last-Query' }, + { text: 'Fill Null Value', link: 'Fill-Null-Value' }, + { text: 'Without Null', link: 'Without-Null' }, + { text: 'Tracing Tool', link: 'Tracing-Tool' }, + ], + }, + { + text: 'Process Data', + collapsible: true, + prefix: 'Process-Data/', + children: [ + { text: 'UDF (User Defined Function)', link: 'UDF-User-Defined-Function' }, + { text: 'Query Write-back (SELECT INTO)', link: 'Select-Into' }, + { text: 'CQ (Continuous Query)', link: 'Continuous-Query' }, + { text: 'Triggers', link: 'Triggers' }, + { text: 'Alerting', link: 'Alerting' }, + ], + }, + { + text: 'Administration Management', + collapsible: true, + prefix: 'Administration-Management/', + children: [ + { text: 'Administration', link: 'Administration' }, + ], + }, + { + text: 'Maintenance Tools', + collapsible: true, + prefix: 'Maintenance-Tools/', + children: [ + { text: 'Maintenance Command', link: 'Maintenance-Command' }, + { text: 'Log Tool', link: 'Log-Tool' }, + { text: 'JMX Tool', link: 'JMX-Tool' }, + { text: 'MLogParser Tool', link: 'MLogParser-Tool' }, + { text: 'MLogLoad Tool', link: 'MLogLoad-Tool' }, + { text: 'Export Schema Tool', link: 'Export-Schema-Tool' }, + { text: 'Node Tool', link: 'NodeTool' }, + { text: 'Watermark Tool', link: 'Watermark-Tool' }, + { text: 'Metric Tool', link: 'Metric-Tool' }, + { text: 'Sync Tool', link: 'Sync-Tool' }, + { text: 'TsFile Split Tool', link: 'TsFile-Split-Tool' }, + ], + }, + { + text: 'Ecosystem Integration', + collapsible: true, + prefix: 'Ecosystem-Integration/', + children: [ + { text: 'Grafana Plugin', link: 'Grafana-Plugin' }, + { text: 'Grafana Connector (Not Recommended)', link: 'Grafana-Connector' }, + { text: 'Zeppelin-IoTDB', link: 'Zeppelin-IoTDB' }, + { text: 'DBeaver-IoTDB', link: 'DBeaver' }, + { text: 'MapReduce TsFile', link: 'MapReduce-TsFile' }, + { text: 'Spark TsFile', link: 'Spark-TsFile' }, + { text: 'Spark IoTDB', link: 'Spark-IoTDB' }, + { text: 'Hive TsFile', link: 'Hive-TsFile' }, + { text: 'Flink IoTDB', link: 'Flink-IoTDB' }, + { text: 'Flink TsFile', link: 'Flink-TsFile' }, + { text: 'NiFi IoTDB', link: 'NiFi-IoTDB' }, + ], + }, + { + text: 'UDF Library', + collapsible: true, + prefix: 'UDF-Library/', + children: [ + { text: 'Quick Start', link: 'Quick-Start' }, + { text: 'Data Profiling', link: 'Data-Profiling' }, + { text: 'Anomaly Detection', link: 'Anomaly-Detection' }, + { text: 'Data Matching', link: 'Data-Matching' }, + { text: 'Frequency Domain Analysis', link: 'Frequency-Domain' }, + { text: 'Data Quality', link: 'Data-Quality' }, + { text: 'Data Repairing', link: 'Data-Repairing' }, + { text: 'Series Discovery', link: 'Series-Discovery' }, + { text: 'String Processing', link: 'String-Processing' }, + { text: 'M4', link: 'M4' }, + ], + }, + { + text: 'Reference', + collapsible: true, + prefix: 'Reference/', + children: [ + { text: 'Config Manual', link: 'Config-Manual' }, + { text: 'Keywords', link: 'Keywords' }, + { text: 'Frequently asked questions', link: 'Frequently-asked-questions' }, + { text: 'TSDB Comparison', link: 'TSDB-Comparison' }, + ], + }, + ], +}; diff --git a/src/.vuepress/sidebar_timecho/V0.13.x/zh.ts b/src/.vuepress/sidebar_timecho/V0.13.x/zh.ts new file mode 100644 index 0000000..343e2a0 --- /dev/null +++ b/src/.vuepress/sidebar_timecho/V0.13.x/zh.ts @@ -0,0 +1,223 @@ +/* + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +export const zhSidebar = { + '/zh/UserGuide/V0.13.x/': [ + { + text: 'IoTDB用户手册 (V0.13.x)', + collapsible: false, + children: [], + }, + { + text: 'IoTDB简介', + collapsible: true, + prefix: 'IoTDB-Introduction/', + children: [ + { text: 'IoTDB简介', link: 'What-is-IoTDB' }, + { text: '主要功能特点', link: 'Features' }, + // { text: '系统架构', link: 'Architecture' }, + // { text: '应用场景', link: 'Scenario' }, + { text: '研究论文', link: 'Publication' }, + ], + }, + { + text: '快速上手', + collapsible: true, + prefix: 'QuickStart/', + children: [ + { text: '快速上手', link: 'QuickStart' }, + { text: '数据文件存储', link: 'Files' }, + { text: '下载与安装', link: 'WayToGetIoTDB' }, + { text: 'SQL命令行终端(CLI)', link: 'Command-Line-Interface' }, + ], + }, + { + text: '数据模式与概念', + collapsible: true, + prefix: 'Data-Concept/', + children: [ + { text: '数据模型', link: 'Data-Model-and-Terminology' }, + { text: '元数据模板', link: 'Schema-Template' }, + { text: '数据类型', link: 'Data-Type' }, + { text: '死区处理', link: 'Deadband-Process' }, + { text: '编码方式', link: 'Encoding' }, + { text: '压缩方式', link: 'Compression' }, + { text: '时间分区', link: 'Time-Partition' }, + { text: '时区', link: 'Time-zone' }, + ], + }, + { + text: '语法约定', + collapsible: true, + prefix: 'Reference/', + children: [ + { text: '语法约定', link: 'Syntax-Conventions' }, + ], + }, + { + text: '应用编程接口', + collapsible: true, + prefix: 'API/', + children: [ + { text: 'Java 原生接口', link: 'Programming-Java-Native-API' }, + { text: 'Python 原生接口', link: 'Programming-Python-Native-API' }, + { text: 'C++ 原生接口', link: 'Programming-Cpp-Native-API' }, + { text: 'Go 原生接口', link: 'Programming-Go-Native-API' }, + { text: 'JDBC (不推荐)', link: 'Programming-JDBC' }, + { text: 'MQTT', link: 'Programming-MQTT' }, + { text: 'REST API', link: 'RestService' }, + { text: 'TsFile API', link: 'Programming-TsFile-API' }, + { text: '状态码', link: 'Status-Codes' }, + ], + }, + { + text: '元数据操作', + collapsible: true, + prefix: 'Operate-Metadata/', + children: [ + { text: '存储组操作', link: 'Storage-Group' }, + { text: '节点操作', link: 'Node' }, + { text: '时间序列操作', link: 'Timeseries' }, + { text: '元数据模板', link: 'Template' }, + { text: 'TTL', link: 'TTL' }, + { text: '自动创建元数据', link: 'Auto-Create-MetaData' }, + ], + }, + { + text: '数据写入和删除', + collapsible: true, + prefix: 'Write-And-Delete-Data/', + children: [ + { text: '写入数据', link: 'Write-Data' }, + { text: '加载 TsFile', link: 'Load-External-Tsfile' }, + { text: '导入导出 CSV', link: 'CSV-Tool' }, + { text: '删除数据', link: 'Delete-Data' }, + ], + }, + { + text: '数据查询', + collapsible: true, + prefix: 'Query-Data/', + children: [ + { text: '概述', link: 'Overview' }, + { text: '选择表达式', link: 'Select-Expression' }, + { text: '查询过滤条件', link: 'Query-Filter' }, + { text: '查询结果分页', link: 'Pagination' }, + { text: '查询结果对齐格式', link: 'Result-Format' }, + { text: '聚合查询', link: 'Aggregate-Query' }, + { text: '最新点查询', link: 'Last-Query' }, + { text: '空值填充', link: 'Fill-Null-Value' }, + { text: '空值过滤', link: 'Without-Null' }, + { text: '查询性能追踪', link: 'Tracing-Tool' }, + ], + }, + { + text: '数据处理', + collapsible: true, + prefix: 'Process-Data/', + children: [ + { text: '用户定义函数(UDF)', link: 'UDF-User-Defined-Function' }, + { text: '查询写回(SELECT INTO)', link: 'Select-Into' }, + { text: '连续查询(CQ)', link: 'Continuous-Query' }, + { text: '触发器', link: 'Triggers' }, + { text: '告警机制', link: 'Alerting' }, + ], + }, + { + text: '权限管理', + collapsible: true, + prefix: 'Administration-Management/', + children: [ + { text: '权限管理', link: 'Administration' }, + ], + }, + { + text: '双活版本', + collapsible: true, + prefix: 'Active-Active/', + children: [ + { text: '双活', link: 'Active-Active' }, + ], + }, + { + text: '运维工具', + collapsible: true, + prefix: 'Maintenance-Tools/', + children: [ + { text: '运维命令', link: 'Maintenance-Command' }, + { text: '日志工具', link: 'Log-Tool' }, + { text: 'JMX 工具', link: 'JMX-Tool' }, + { text: 'MLog 解析工具', link: 'MLogParser-Tool' }, + { text: 'MLog 加载工具', link: 'MLogLoad-Tool' }, + { text: '元数据导出工具', link: 'Export-Schema-Tool' }, + { text: '节点工具', link: 'NodeTool' }, + { text: '水印工具', link: 'Watermark-Tool' }, + { text: '监控工具', link: 'Metric-Tool' }, + { text: 'TsFile 同步工具', link: 'Sync-Tool' }, + { text: 'TsFile 拆分工具', link: 'TsFile-Split-Tool' }, + ], + }, + { + text: '系统集成', + collapsible: true, + prefix: 'Ecosystem-Integration/', + children: [ + { text: 'Grafana Plugin', link: 'Grafana-Plugin' }, + { text: 'Grafana Connector（不推荐）', link: 'Grafana-Connector' }, + { text: 'Zeppelin-IoTDB', link: 'Zeppelin-IoTDB' }, + { text: 'DBeaver-IoTDB', link: 'DBeaver' }, + { text: 'Spark-TsFile', link: 'Spark-TsFile' }, + { text: 'Hadoop-TsFile', link: 'MapReduce-TsFile' }, + { text: 'Spark-IoTDB', link: 'Spark-IoTDB' }, + { text: 'Hive-TsFile', link: 'Hive-TsFile' }, + { text: 'Flink-TsFile', link: 'Flink-TsFile' }, + { text: 'Flink-IoTDB', link: 'Flink-IoTDB' }, + { text: 'NiFi IoTDB', link: 'NiFi-IoTDB' }, + ], + }, + { + text: 'UDF 资料库', + collapsible: true, + prefix: 'UDF-Library/', + children: [ + { text: '快速开始', link: 'Quick-Start' }, + { text: '数据画像', link: 'Data-Profiling' }, + { text: '异常检测', link: 'Anomaly-Detection' }, + { text: '数据匹配', link: 'Data-Matching' }, + { text: '频域分析', link: 'Frequency-Domain' }, + { text: '数据质量', link: 'Data-Quality' }, + { text: '数据修复', link: 'Data-Repairing' }, + { text: '序列发现', link: 'Series-Discovery' }, + { text: '字符串处理', link: 'String-Processing' }, + { text: 'M4', link: 'M4' }, + ], + }, + { + text: '参考', + collapsible: true, + prefix: 'Reference/', + children: [ + { text: '配置参数', link: 'Config-Manual' }, + { text: '关键字', link: 'Keywords' }, + { text: '常见问题', link: 'Frequently-asked-questions' }, + { text: '时间序列数据库比较', link: 'TSDB-Comparison' }, + ], + }, + ], +}; diff --git a/src/.vuepress/sidebar_timecho/V1.0.x/en.ts b/src/.vuepress/sidebar_timecho/V1.0.x/en.ts new file mode 100644 index 0000000..5b4d868 --- /dev/null +++ b/src/.vuepress/sidebar_timecho/V1.0.x/en.ts @@ -0,0 +1,285 @@ +/* + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +export const enSidebar = { + '/UserGuide/V1.0.x/': [ + { + text: 'IoTDB User Guide (V1.0.x)', + collapsible: false, + children: [], + }, + { + text: 'About IoTDB', + collapsible: true, + prefix: 'IoTDB-Introduction/', + children: [ + { text: 'What is IoTDB', link: 'What-is-IoTDB' }, + { text: 'Architecture', link: 'Architecture' }, + { text: 'Scenario', link: 'Scenario' }, + { text: 'Features', link: 'Features' }, + { text: 'Publication', link: 'Publication' }, + ], + }, + { + text: 'Quick Start', + collapsible: true, + prefix: 'QuickStart/', + children: [ + { text: 'Quick Start', link: 'QuickStart' }, + { text: 'Download and Setup', link: 'WayToGetIoTDB' }, + { text: 'Command Line Interface', link: 'Command-Line-Interface' }, + { text: 'Data storage', link: 'Files' }, + ], + }, + { + text: 'Data Concept', + collapsible: true, + prefix: 'Data-Concept/', + children: [ + { text: 'Data Model and Terminology', link: 'Data-Model-and-Terminology' }, + { text: 'Schema Template', link: 'Schema-Template' }, + { text: 'Data Type', link: 'Data-Type' }, + { text: 'Deadband Process', link: 'Deadband-Process' }, + { text: 'Encoding', link: 'Encoding' }, + { text: 'Compression', link: 'Compression' }, + { text: 'Time Partition of Data', link: 'Time-Partition' }, + { text: 'Time zone', link: 'Time-zone' }, + ], + }, + { + text: 'Syntax Conventions', + collapsible: true, + prefix: 'Syntax-Conventions/', + children: [ + { text: 'Literal Values', link: 'Literal-Values' }, + { text: 'Identifier', link: 'Identifier' }, + { text: 'NodeName in Path', link: 'NodeName-In-Path' }, + { text: 'Key-Value Pair', link: 'KeyValue-Pair' }, + { text: 'Keywords', link: 'Keywords-And-Reserved-Words' }, + { text: 'Session And TsFile API', link: 'Session-And-TsFile-API' }, + { text: 'Detailed Definitions of Lexical and Grammar', link: 'Detailed-Grammar' }, + ], + }, + { + text: 'API', + collapsible: true, + prefix: 'API/', + children: [ + { text: 'Java Native API', link: 'Programming-Java-Native-API' }, + { text: 'Python Native API', link: 'Programming-Python-Native-API' }, + { text: 'C++ Native API', link: 'Programming-Cpp-Native-API' }, + { text: 'Go Native API', link: 'Programming-Go-Native-API' }, + { text: 'JDBC (Not Recommend)', link: 'Programming-JDBC' }, + { text: 'MQTT', link: 'Programming-MQTT' }, + { text: 'REST API', link: 'RestService' }, + { text: 'TsFile API', link: 'Programming-TsFile-API' }, + { text: 'InfluxDB Protocol', link: 'InfluxDB-Protocol' }, + { text: 'Interface Comparison', link: 'Interface-Comparison' }, + ], + }, + { + text: 'Operate Metadata', + collapsible: true, + prefix: 'Operate-Metadata/', + children: [ + { text: 'Database', link: 'Database' }, + { text: 'Node', link: 'Node' }, + { text: 'Timeseries', link: 'Timeseries' }, + { text: 'Schema Template', link: 'Template' }, + { text: 'Auto Create Metadata', link: 'Auto-Create-MetaData' }, + ], + }, + { + text: 'Write Data (Update Data)', + collapsible: true, + prefix: 'Write-Data/', + children: [ + { text: 'CLI Write', link: 'Write-Data' }, + { text: 'Native API Write', link: 'Session' }, + { text: 'REST API', link: 'REST-API' }, + { text: 'MQTT Write', link: 'MQTT' }, + { text: 'Batch Data Load', link: 'Batch-Load-Tool' }, + ], + }, + { + text: 'Delete Data', + collapsible: true, + prefix: 'Delete-Data/', + children: [ + { text: 'Delete Data', link: 'Delete-Data' }, + { text: 'TTL', link: 'TTL' }, + ], + }, + { + text: 'Query Data', + collapsible: true, + prefix: 'Query-Data/', + children: [ + { text: 'Overview', link: 'Overview' }, + { text: 'Select Expression', link: 'Select-Expression' }, + { text: 'Last Query', link: 'Last-Query' }, + { text: 'Query Alignment Mode', link: 'Align-By' }, + { text: 'Where Condition', link: 'Where-Condition' }, + { text: 'Group By', link: 'Group-By' }, + { text: 'Having Condition', link: 'Having-Condition' }, + // { text: 'Order By', link: 'Order-By' }, + { text: 'Fill Null Value', link: 'Fill' }, + { text: 'Pagination', link: 'Pagination' }, + { text: 'Select Into', link: 'Select-Into' }, + { text: 'Continuous Query', link: 'Continuous-Query' }, + ], + }, + { + text: 'Operators and Functions', + collapsible: true, + prefix: 'Operators-Functions/', + children: [ + { text: 'Overview', link: 'Overview' }, + { text: 'UDF (User Defined Function)', link: 'User-Defined-Function' }, + { text: 'Aggregation', link: 'Aggregation' }, + { text: 'Mathematical', link: 'Mathematical' }, + { text: 'Comparison', link: 'Comparison' }, + { text: 'Logical', link: 'Logical' }, + { text: 'Conversion', link: 'Conversion' }, + { text: 'Constant', link: 'Constant' }, + { text: 'Selection', link: 'Selection' }, + { text: 'Continuous Interval', link: 'Continuous-Interval' }, + { text: 'Variation Trend', link: 'Variation-Trend' }, + { text: 'Sample', link: 'Sample' }, + { text: 'Time-Series', link: 'Time-Series' }, + { text: 'Lambda', link: 'Lambda' }, + + // IoTDB-Quality + { text: 'Data Profiling', link: 'Data-Profiling' }, + { text: 'Anomaly Detection', link: 'Anomaly-Detection' }, + { text: 'Data Matching', link: 'Data-Matching' }, + { text: 'Frequency Domain', link: 'Frequency-Domain' }, + { text: 'Data Quality', link: 'Data-Quality' }, + { text: 'Data Repairing', link: 'Data-Repairing' }, + { text: 'Series Discovery', link: 'Series-Discovery' }, + ], + }, + { + text: 'Trigger', + collapsible: true, + prefix: 'Trigger/', + children: [ + { text: 'Instructions', link: 'Instructions' }, + { text: 'How to implement a trigger', link: 'Implement-Trigger' }, + { text: 'Trigger Management', link: 'Trigger-Management' }, + { text: 'Notes', link: 'Notes' }, + { text: 'Configuration-Parameters', link: 'Configuration-Parameters' }, + ], + }, + { + text: 'Monitor and Alert', + collapsible: true, + prefix: 'Monitor-Alert/', + children: [ + { text: 'Metric Tool', link: 'Metric-Tool' }, + { text: 'Alerting', link: 'Alerting' }, + ], + }, + { + text: 'Administration Management', + collapsible: true, + prefix: 'Administration-Management/', + children: [ + { text: 'Administration', link: 'Administration' }, + ], + }, + { + text: 'Maintenance Tools', + collapsible: true, + prefix: 'Maintenance-Tools/', + children: [ + { text: 'Maintenance Command', link: 'Maintenance-Command' }, + { text: 'Log Tool', link: 'Log-Tool' }, + { text: 'JMX Tool', link: 'JMX-Tool' }, + { text: 'MLogParser Tool', link: 'MLogParser-Tool' }, + { text: 'IoTDB Data Directory Overview Tool', link: 'IoTDB-Data-Dir-Overview-Tool' }, + { text: 'TsFile Sketch Tool', link: 'TsFile-Sketch-Tool' }, + { text: 'TsFile Resource Sketch Tool', link: 'TsFile-Resource-Sketch-Tool' }, + { text: 'TsFile Split Tool', link: 'TsFile-Split-Tool' }, + { text: 'TsFile Load Export Tool', link: 'TsFile-Load-Export-Tool' }, + { text: 'CSV Load Export Tool', link: 'CSV-Tool' }, + ], + }, + { + text: 'Collaboration of Edge and Cloud', + collapsible: true, + prefix: 'Edge-Cloud-Collaboration/', + children: [ + { text: 'TsFile Sync Tool', link: 'Sync-Tool' }, + ], + }, + { + text: 'Ecosystem Integration', + collapsible: true, + prefix: 'Ecosystem-Integration/', + children: [ + { text: 'Grafana-Plugin', link: 'Grafana-Plugin' }, + { text: 'Grafana-Connector (Not Recommended)', link: 'Grafana-Connector' }, + { text: 'Zeppelin-IoTDB', link: 'Zeppelin-IoTDB' }, + { text: 'DBeaver-IoTDB', link: 'DBeaver' }, + { text: 'MapReduce-TsFile', link: 'MapReduce-TsFile' }, + { text: 'Spark-TsFile', link: 'Spark-TsFile' }, + { text: 'Spark-IoTDB', link: 'Spark-IoTDB' }, + { text: 'Hive-TsFile', link: 'Hive-TsFile' }, + { text: 'Flink-IoTDB', link: 'Flink-IoTDB' }, + { text: 'Flink-TsFile', link: 'Flink-TsFile' }, + { text: 'NiFi-IoTDB', link: 'NiFi-IoTDB' }, + ], + }, + { + text: 'Cluster', + collapsible: true, + prefix: 'Cluster/', + children: [ + { text: 'Cluster Concept', link: 'Cluster-Concept' }, + { text: 'Cluster Setup', link: 'Cluster-Setup' }, + { text: 'Cluster Maintenance', link: 'Cluster-Maintenance' }, + { text: 'Deployment Recommendation', link: 'Deployment-Recommendation' }, + ], + }, + { + text: 'FAQ', + collapsible: true, + prefix: 'FAQ/', + children: [ + { text: 'Frequently asked questions', link: 'Frequently-asked-questions' }, + { text: 'FAQ for cluster setup', link: 'FAQ-for-cluster-setup' }, + ], + }, + { + text: 'Reference', + collapsible: true, + prefix: 'Reference/', + children: [ + { text: 'Common Config Manual', link: 'Common-Config-Manual' }, + { text: 'ConfigNode Config Manual', link: 'ConfigNode-Config-Manual' }, + { text: 'DataNode Config Manual', link: 'DataNode-Config-Manual' }, + { text: 'SQL Reference', link: 'SQL-Reference' }, + { text: 'Status Codes', link: 'Status-Codes' }, + { text: 'Keywords', link: 'Keywords' }, + { text: 'TSDB Comparison', link: 'TSDB-Comparison' }, + ], + }, + ], +}; diff --git a/src/.vuepress/sidebar_timecho/V1.0.x/zh.ts b/src/.vuepress/sidebar_timecho/V1.0.x/zh.ts new file mode 100644 index 0000000..4791a02 --- /dev/null +++ b/src/.vuepress/sidebar_timecho/V1.0.x/zh.ts @@ -0,0 +1,289 @@ +/* + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +export const zhSidebar = { + '/zh/UserGuide/V1.0.x/': [ + { + text: 'IoTDB用户手册 (V1.0.x)', + collapsible: false, + children: [], + }, + { + text: '关于IoTDB', + collapsible: true, + prefix: 'IoTDB-Introduction/', + children: [ + { text: 'IoTDB简介', link: 'What-is-IoTDB' }, + { text: '主要功能特点', link: 'Features' }, + // { text: '系统架构', link: 'Architecture' }, + // { text: '应用场景', link: 'Scenario' }, + { text: '研究论文', link: 'Publication' }, + ], + }, + { + text: '快速上手', + collapsible: true, + prefix: 'QuickStart/', + children: [ + { text: '快速上手', link: 'QuickStart' }, + // { text: '下载与安装', link: 'WayToGetIoTDB' }, +// { text: 'SQL命令行终端(CLI)', link: 'Command-Line-Interface' }, +// { text: '数据文件存储', link: 'Files' }, + ], + }, + { + text: '安全管理', + collapsible: true, + prefix: 'Security-Management/', + // children: 'structure', + children: [ + { text: '白名单', link: 'White-List' }, + { text: '审计日志', link: 'Audit-Log' }, + { text: '权限管理', link: 'Administration' }, + ], + }, + { + text: '基础概念', + collapsible: true, + prefix: 'Basic-Concept/', + children: [ + { text: '数据模型', link: 'Data-Model-and-Terminology' }, + // { text: '元数据模板', link: 'Schema-Template' }, + { text: '数据类型', link: 'Data-Type' }, + // { text: '死区处理', link: 'Deadband-Process' }, + { text: '编码和压缩', link: 'Encoding-and-Compression' }, + // { text: '数据的时间分区', link: 'Time-Partition' }, + // { text: '时区', link: 'Time-zone' }, + ], + }, + { + text: '语法约定', + collapsible: true, + prefix: 'Syntax-Conventions/', + children: [ + { text: '字面值常量', link: 'Literal-Values' }, + { text: '标识符', link: 'Identifier' }, + { text: '路径结点名', link: 'NodeName-In-Path' }, + { text: '键值对', link: 'KeyValue-Pair' }, + { text: '关键字', link: 'Keywords-And-Reserved-Words' }, + { text: 'Session And TsFile API', link: 'Session-And-TsFile-API' }, + { text: '词法和文法详细定义', link: 'Detailed-Grammar' }, + ], + }, + { + text: '应用编程接口', + collapsible: true, + prefix: 'API/', + children: [ + { text: 'Java 原生接口', link: 'Programming-Java-Native-API' }, + { text: 'Python 原生接口', link: 'Programming-Python-Native-API' }, + { text: 'C++ 原生接口', link: 'Programming-Cpp-Native-API' }, + { text: 'Go 原生接口', link: 'Programming-Go-Native-API' }, + { text: 'JDBC (不推荐)', link: 'Programming-JDBC' }, + { text: 'MQTT', link: 'Programming-MQTT' }, + { text: 'REST API', link: 'RestService' }, + { text: 'TsFile API', link: 'Programming-TsFile-API' }, + { text: 'InfluxDB 协议适配器', link: 'InfluxDB-Protocol' }, + { text: '原生接口对比', link: 'Interface-Comparison' }, + ], + }, + { + text: '元数据操作', + collapsible: true, + prefix: 'Operate-Metadata/', + children: [ + { text: '数据库操作', link: 'Database' }, + { text: '节点操作', link: 'Node' }, + { text: '时间序列操作', link: 'Timeseries' }, + { text: '元数据模板', link: 'Template' }, + { text: '自动创建元数据', link: 'Auto-Create-MetaData' }, + ], + }, + { + text: '数据写入（数据更新）', + collapsible: true, + prefix: 'Write-Data/', + children: [ + { text: 'CLI 写入数据', link: 'Write-Data' }, + { text: '原生接口写入', link: 'Session' }, + { text: 'REST 服务', link: 'REST-API' }, + { text: 'MQTT 写入', link: 'MQTT' }, + { text: '批量数据导入', link: 'Batch-Load-Tool' }, + ], + }, + { + text: '数据删除', + collapsible: true, + prefix: 'Delete-Data/', + children: [ + { text: '删除数据', link: 'Delete-Data' }, + { text: 'TTL', link: 'TTL' }, + ], + }, + { + text: '数据查询', + collapsible: true, + prefix: 'Query-Data/', + children: [ + { text: '概述', link: 'Overview' }, + { text: '选择表达式', link: 'Select-Expression' }, + { text: '最新点查询', link: 'Last-Query' }, + { text: '查询对齐模式', link: 'Align-By' }, + { text: '查询过滤条件', link: 'Where-Condition' }, + { text: '分段分组聚合', link: 'Group-By' }, + { text: '聚合结果过滤', link: 'Having-Condition' }, + // { text:'结果集排序', link: 'Order-By' }, + { text: '结果集补空值', link: 'Fill' }, + { text: '结果集分页', link: 'Pagination' }, + { text: '查询写回', link: 'Select-Into' }, + { text: '连续查询', link: 'Continuous-Query' }, + ], + }, + { + text: '运算符和函数', + collapsible: true, + prefix: 'Operators-Functions/', + children: [ + { text: '概述', link: 'Overview' }, + { text: '用户自定义函数', link: 'User-Defined-Function' }, + { text: '聚合函数', link: 'Aggregation' }, + { text: '算数运算符和函数', link: 'Mathematical' }, + { text: '比较运算符和函数', link: 'Comparison' }, + { text: '逻辑运算符', link: 'Logical' }, + { text: '字符串处理', link: 'String' }, + { text: '数据类型转换', link: 'Conversion' }, + { text: '常序列生成', link: 'Constant' }, + { text: '选择函数', link: 'Selection' }, + { text: '区间查询', link: 'Continuous-Interval' }, + { text: '趋势计算', link: 'Variation-Trend' }, + { text: '采样函数', link: 'Sample' }, + { text: '时间序列处理', link: 'Time-Series' }, + { text: 'Lambda 表达式', link: 'Lambda' }, + + // IoTDB-Quality + { text: '数据画像', link: 'Data-Profiling' }, + { text: '异常检测', link: 'Anomaly-Detection' }, + { text: '数据匹配', link: 'Data-Matching' }, + { text: '频域分析', link: 'Frequency-Domain' }, + { text: '数据质量', link: 'Data-Quality' }, + { text: '数据修复', link: 'Data-Repairing' }, + { text: '序列发现', link: 'Series-Discovery' }, + ], + }, + { + text: '触发器', + collapsible: true, + prefix: 'Trigger/', + children: [ + { text: '使用说明', link: 'Instructions' }, + { text: '编写触发器', link: 'Implement-Trigger' }, + { text: '管理触发器', link: 'Trigger-Management' }, + { text: '重要注意事项', link: 'Notes' }, + { text: '配置参数', link: 'Configuration-Parameters' }, + ], + }, + { + text: '监控告警', + collapsible: true, + prefix: 'Monitor-Alert/', + children: [ + { text: '监控工具', link: 'Metric-Tool' }, + { text: '告警机制', link: 'Alerting' }, + ], + }, + { + text: '运维工具', + collapsible: true, + prefix: 'Maintenance-Tools/', + children: [ + { text: '运维命令', link: 'Maintenance-Command' }, + { text: '日志工具', link: 'Log-Tool' }, + { text: 'JMX 工具', link: 'JMX-Tool' }, + { text: 'Mlog解析工具', link: 'MLogParser-Tool' }, + { text: 'IoTDB数据文件夹概览工具', link: 'IoTDB-Data-Dir-Overview-Tool' }, + { text: 'TsFile概览工具', link: 'TsFile-Sketch-Tool' }, + { text: 'TsFile Resource概览工具', link: 'TsFile-Resource-Sketch-Tool' }, + { text: 'TsFile 拆分工具', link: 'TsFile-Split-Tool' }, + { text: 'TsFile 导入导出工具', link: 'TsFile-Load-Export-Tool' }, + { text: 'CSV 导入导出工具', link: 'CSV-Tool' }, + ], + }, + { + text: '端云协同', + collapsible: true, + prefix: 'Edge-Cloud-Collaboration/', + children: [ + { text: 'TsFile 同步工具', link: 'Sync-Tool' }, + ], + }, + { + text: '系统集成', + collapsible: true, + prefix: 'Ecosystem-Integration/', + children: [ + { text: 'Grafana-Plugin', link: 'Grafana-Plugin' }, + { text: 'Grafana-Connector（不推荐）', link: 'Grafana-Connector' }, + { text: 'Zeppelin-IoTDB', link: 'Zeppelin-IoTDB' }, + { text: 'DBeaver-IoTDB', link: 'DBeaver' }, + { text: 'MapReduce-TsFile', link: 'MapReduce-TsFile' }, + { text: 'Spark-TsFile', link: 'Spark-TsFile' }, + { text: 'Spark-IoTDB', link: 'Spark-IoTDB' }, + { text: 'Hive-TsFile', link: 'Hive-TsFile' }, + { text: 'Flink-IoTDB', link: 'Flink-IoTDB' }, + { text: 'Flink-TsFile', link: 'Flink-TsFile' }, + { text: 'NiFi-IoTDB', link: 'NiFi-IoTDB' }, + ], + }, + { + text: '分布式', + collapsible: true, + prefix: 'Cluster/', + children: [ + { text: '基本概念', link: 'Cluster-Concept' }, + { text: '分布式部署', link: 'Cluster-Setup' }, + { text: '分布式运维命令', link: 'Cluster-Maintenance' }, + { text: '部署推荐', link: 'Deployment-Recommendation' }, + { text: '异构 Database', link: 'Heterogeneous-DataBase' }, + ], + }, + { + text: 'FAQ', + collapsible: true, + prefix: 'FAQ/', + children: [ + { text: '常见问题', link: 'Frequently-asked-questions' }, + { text: '分布式部署FAQ', link: 'FAQ-for-cluster-setup' }, + ], + }, + { + text: '参考', + collapsible: true, + prefix: 'Reference/', + children: [ + { text: '公共配置参数', link: 'Common-Config-Manual' }, + { text: 'ConfigNode配置参数', link: 'ConfigNode-Config-Manual' }, + { text: 'DataNode配置参数', link: 'DataNode-Config-Manual' }, + { text: 'SQL参考文档', link: 'SQL-Reference' }, + { text: '状态码', link: 'Status-Codes' }, + { text: '关键字', link: 'Keywords' }, + { text: '时间序列数据库比较', link: 'TSDB-Comparison' }, + ], + }, + ], +}; diff --git a/src/.vuepress/sidebar_timecho/V1.1.x/en.ts b/src/.vuepress/sidebar_timecho/V1.1.x/en.ts new file mode 100644 index 0000000..f9619f0 --- /dev/null +++ b/src/.vuepress/sidebar_timecho/V1.1.x/en.ts @@ -0,0 +1,306 @@ +/* + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +export const enSidebar = { + '/UserGuide/V1.1.x/': [ + { + text: 'IoTDB User Guide (V1.1.x)', + children: [], + }, + { + text: 'About IoTDB', + collapsible: true, + prefix: 'IoTDB-Introduction/', + // children: 'structure', + children: [ + { text: 'What is IoTDB', link: 'What-is-IoTDB' }, + { text: 'Architecture', link: 'Architecture' }, + { text: 'Scenario', link: 'Scenario' }, + { text: 'Features', link: 'Features' }, + { text: 'Publication', link: 'Publication' }, + ], + }, + { + text: 'Quick Start', + collapsible: true, + prefix: 'QuickStart/', + // children: 'structure', + children: [ + { text: 'Quick Start', link: 'QuickStart' }, + { text: 'Cluster Quick Start', link: 'ClusterQuickStart' }, + { text: 'Download and Setup', link: 'WayToGetIoTDB' }, + { text: 'Command Line Interface', link: 'Command-Line-Interface' }, + { text: 'Data storage', link: 'Files' }, + ], + }, + { + text: 'Data Concept', + collapsible: true, + prefix: 'Data-Concept/', + // children: 'structure', + children: [ + { text: 'Data Model and Terminology', link: 'Data-Model-and-Terminology' }, + { text: 'Schema Template', link: 'Schema-Template' }, + { text: 'Data Type', link: 'Data-Type' }, + { text: 'Deadband Process', link: 'Deadband-Process' }, + { text: 'Encoding', link: 'Encoding' }, + { text: 'Compression', link: 'Compression' }, + { text: 'Time Partition of Data', link: 'Time-Partition' }, + { text: 'Time zone', link: 'Time-zone' }, + ], + }, + { + text: 'Syntax Conventions', + collapsible: true, + prefix: 'Syntax-Conventions/', + // children: 'structure', + children: [ + { text: 'Literal Values', link: 'Literal-Values' }, + { text: 'Identifier', link: 'Identifier' }, + { text: 'NodeName in Path', link: 'NodeName-In-Path' }, + { text: 'Key-Value Pair', link: 'KeyValue-Pair' }, + { text: 'Keywords', link: 'Keywords-And-Reserved-Words' }, + { text: 'Session And TsFile API', link: 'Session-And-TsFile-API' }, + { text: 'Detailed Definitions of Lexical and Grammar', link: 'Detailed-Grammar' }, + ], + }, + { + text: 'API', + collapsible: true, + prefix: 'API/', + // children: 'structure', + children: [ + { text: 'Java Native API', link: 'Programming-Java-Native-API' }, + { text: 'Python Native API', link: 'Programming-Python-Native-API' }, + { text: 'C++ Native API', link: 'Programming-Cpp-Native-API' }, + { text: 'Go Native API', link: 'Programming-Go-Native-API' }, + { text: 'JDBC (Not Recommend)', link: 'Programming-JDBC' }, + { text: 'MQTT', link: 'Programming-MQTT' }, + { text: 'REST API V1 (Not Recommend)', link: 'RestServiceV1' }, + { text: 'REST API V2', link: 'RestServiceV2' }, + { text: 'TsFile API', link: 'Programming-TsFile-API' }, + { text: 'InfluxDB Protocol', link: 'InfluxDB-Protocol' }, + { text: 'Interface Comparison', link: 'Interface-Comparison' }, + ], + }, + { + text: 'Operate Metadata', + collapsible: true, + prefix: 'Operate-Metadata/', + // children: 'structure', + children: [ + { text: 'Database', link: 'Database' }, + { text: 'Node', link: 'Node' }, + { text: 'Timeseries', link: 'Timeseries' }, + { text: 'Schema Template', link: 'Template' }, + { text: 'Auto Create Metadata', link: 'Auto-Create-MetaData' }, + ], + }, + { + text: 'Write Data (Update Data)', + collapsible: true, + prefix: 'Write-Data/', + // children: 'structure', + children: [ + { text: 'CLI Write', link: 'Write-Data' }, + { text: 'Native API Write', link: 'Session' }, + { text: 'REST API', link: 'REST-API' }, + { text: 'MQTT Write', link: 'MQTT' }, + { text: 'Batch Data Load', link: 'Batch-Load-Tool' }, + ], + }, + { + text: 'Delete Data', + collapsible: true, + prefix: 'Delete-Data/', + // children: 'structure', + children: [ + { text: 'Delete Data', link: 'Delete-Data' }, + { text: 'TTL', link: 'TTL' }, + ], + }, + { + text: 'Query Data', + collapsible: true, + prefix: 'Query-Data/', + // children: 'structure', + children: [ + { text: 'Overview', link: 'Overview' }, + { text: 'Select Expression', link: 'Select-Expression' }, + { text: 'Last Query', link: 'Last-Query' }, + { text: 'Query Alignment Mode', link: 'Align-By' }, + { text: 'Where Condition', link: 'Where-Condition' }, + { text: 'Group By', link: 'Group-By' }, + { text: 'Having Condition', link: 'Having-Condition' }, + // { text: 'Order By', link: 'Order-By' }, + { text: 'Fill Null Value', link: 'Fill' }, + { text: 'Pagination', link: 'Pagination' }, + { text: 'Select Into', link: 'Select-Into' }, + { text: 'Continuous Query', link: 'Continuous-Query' }, + ], + }, + { + text: 'Operators and Functions', + collapsible: true, + prefix: 'Operators-Functions/', + // children: 'structure', + children: [ + { text: 'Overview', link: 'Overview' }, + { text: 'UDF (User Defined Function)', link: 'User-Defined-Function' }, + { text: 'Aggregation', link: 'Aggregation' }, + { text: 'Mathematical', link: 'Mathematical' }, + { text: 'Comparison', link: 'Comparison' }, + { text: 'Logical', link: 'Logical' }, + { text: 'Conversion', link: 'Conversion' }, + { text: 'Constant', link: 'Constant' }, + { text: 'Selection', link: 'Selection' }, + { text: 'Continuous Interval', link: 'Continuous-Interval' }, + { text: 'Variation Trend', link: 'Variation-Trend' }, + { text: 'Sample', link: 'Sample' }, + { text: 'Time-Series', link: 'Time-Series' }, + { text: 'Lambda', link: 'Lambda' }, + + // IoTDB-Quality + { text: 'Data Profiling', link: 'Data-Profiling' }, + { text: 'Anomaly Detection', link: 'Anomaly-Detection' }, + { text: 'Data Matching', link: 'Data-Matching' }, + { text: 'Frequency Domain', link: 'Frequency-Domain' }, + { text: 'Data Quality', link: 'Data-Quality' }, + { text: 'Data Repairing', link: 'Data-Repairing' }, + { text: 'Series Discovery', link: 'Series-Discovery' }, + { text: 'Machine Learning', link: 'Machine-Learning' }, + ], + }, + { + text: 'Trigger', + collapsible: true, + prefix: 'Trigger/', + // children: 'structure', + children: [ + { text: 'Instructions', link: 'Instructions' }, + { text: 'How to implement a trigger', link: 'Implement-Trigger' }, + { text: 'Trigger Management', link: 'Trigger-Management' }, + { text: 'Notes', link: 'Notes' }, + { text: 'Configuration-Parameters', link: 'Configuration-Parameters' }, + ], + }, + { + text: 'Monitor and Alert', + collapsible: true, + prefix: 'Monitor-Alert/', + // children: 'structure', + children: [ + { text: 'Metric Tool', link: 'Metric-Tool' }, + { text: 'Alerting', link: 'Alerting' }, + ], + }, + { + text: 'Administration Management', + collapsible: true, + prefix: 'Administration-Management/', + // children: 'structure', + children: [ + { text: 'Administration', link: 'Administration' }, + ], + }, + { + text: 'Maintenance Tools', + collapsible: true, + prefix: 'Maintenance-Tools/', + // children: 'structure', + children: [ + { text: 'Maintenance Command', link: 'Maintenance-Command' }, + { text: 'Log Tool', link: 'Log-Tool' }, + { text: 'JMX Tool', link: 'JMX-Tool' }, + { text: 'MLogParser Tool', link: 'MLogParser-Tool' }, + { text: 'IoTDB Data Directory Overview Tool', link: 'IoTDB-Data-Dir-Overview-Tool' }, + { text: 'TsFile Sketch Tool', link: 'TsFile-Sketch-Tool' }, + { text: 'TsFile Resource Sketch Tool', link: 'TsFile-Resource-Sketch-Tool' }, + { text: 'TsFile Split Tool', link: 'TsFile-Split-Tool' }, + { text: 'TsFile Load Export Tool', link: 'TsFile-Load-Export-Tool' }, + { text: 'CSV Load Export Tool', link: 'CSV-Tool' }, + ], + }, + { + text: 'Collaboration of Edge and Cloud', + collapsible: true, + prefix: 'Edge-Cloud-Collaboration/', + // children: 'structure', + children: [ + { text: 'TsFile Sync Tool', link: 'Sync-Tool' }, + ], + }, + { + text: 'Ecosystem Integration', + collapsible: true, + prefix: 'Ecosystem-Integration/', + // children: 'structure', + children: [ + { text: 'Grafana-Plugin', link: 'Grafana-Plugin' }, + { text: 'Grafana-Connector (Not Recommended)', link: 'Grafana-Connector' }, + { text: 'Zeppelin-IoTDB', link: 'Zeppelin-IoTDB' }, + { text: 'DBeaver-IoTDB', link: 'DBeaver' }, + { text: 'MapReduce-TsFile', link: 'MapReduce-TsFile' }, + { text: 'Spark-TsFile', link: 'Spark-TsFile' }, + { text: 'Spark-IoTDB', link: 'Spark-IoTDB' }, + { text: 'Hive-TsFile', link: 'Hive-TsFile' }, + { text: 'Flink-IoTDB', link: 'Flink-IoTDB' }, + { text: 'Flink-TsFile', link: 'Flink-TsFile' }, + { text: 'NiFi-IoTDB', link: 'NiFi-IoTDB' }, + ], + }, + { + text: 'Cluster', + collapsible: true, + prefix: 'Cluster/', + // children: 'structure', + children: [ + { text: 'Cluster Concept', link: 'Cluster-Concept' }, + { text: 'Cluster Setup', link: 'Cluster-Setup' }, + { text: 'Cluster Maintenance', link: 'Cluster-Maintenance' }, + { text: 'Deployment Recommendation', link: 'Deployment-Recommendation' }, + ], + }, + { + text: 'FAQ', + collapsible: true, + prefix: 'FAQ/', + // children: 'structure', + children: [ + { text: 'Frequently asked questions', link: 'Frequently-asked-questions' }, + { text: 'FAQ for cluster setup', link: 'FAQ-for-cluster-setup' }, + ], + }, + { + text: 'Reference', + collapsible: true, + prefix: 'Reference/', + // children: 'structure', + children: [ + { text: 'Common Config Manual', link: 'Common-Config-Manual' }, + { text: 'ConfigNode Config Manual', link: 'ConfigNode-Config-Manual' }, + { text: 'DataNode Config Manual', link: 'DataNode-Config-Manual' }, + { text: 'SQL Reference', link: 'SQL-Reference' }, + { text: 'Status Codes', link: 'Status-Codes' }, + { text: 'Keywords', link: 'Keywords' }, + { text: 'TSDB Comparison', link: 'TSDB-Comparison' }, + ], + }, + ], +}; diff --git a/src/.vuepress/sidebar_timecho/V1.1.x/zh.ts b/src/.vuepress/sidebar_timecho/V1.1.x/zh.ts new file mode 100644 index 0000000..5a2aa71 --- /dev/null +++ b/src/.vuepress/sidebar_timecho/V1.1.x/zh.ts @@ -0,0 +1,175 @@ +/* + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +export const zhSidebar = { + '/zh/UserGuide/V1.1.x/': [ + { + text: 'IoTDB用户手册 (V1.1.x)', + children: [], + }, + { + text: '关于IoTDB', + collapsible: true, + prefix: 'IoTDB-Introduction/', + // children: 'structure', 使用该方式自动获取文件夹下的文件 + children: [ + { text: 'IoTDB简介', link: 'What-is-IoTDB' }, + { text: '主要功能特点', link: 'Features' }, + { text: '系统架构', link: 'Architecture' }, + { text: '应用场景', link: 'Scenario' }, + { text: '研究论文', link: 'Publication' }, + ], + }, + { + text: '快速上手', + collapsible: true, + prefix: 'QuickStart/', + // children: 'structure', + children: [ + { text: '单机版', link: 'QuickStart' }, + { text: '集群版', link: 'ClusterQuickStart' }, +// { text: '下载与安装', link: 'WayToGetIoTDB' }, + { text: '常用SQL语句', link: 'General-SQL-Statements' }, +// { text: 'SQL命令行终端(CLI)', link: 'Command-Line-Interface' }, +// { text: '数据文件存储', link: 'Files' }, + ], + }, + { + text: '基础概念', + collapsible: true, + prefix: 'Basic-Concept/', + // children: 'structure', + children: [ + { text: '数据模型', link: 'Data-Model-and-Terminology' }, +// { text: '元数据模板', link: 'Schema-Template' }, + { text: '数据类型', link: 'Data-Type' }, +// { text: '死区处理', link: 'Deadband-Process' }, + { text: '编码和压缩', link: 'Encoding-and-Compression' }, +// { text: '压缩方式', link: 'Compression' }, +// { text: '数据的时间分区', link: 'Time-Partition' }, +// { text: '时区', link: 'Time-zone' }, + ], + }, + { + text: '部署与运维', + collapsible: true, + prefix: 'Deployment-and-Maintenance/', + // children: 'structure', + children: [ + { text: '环境要求', link: 'Environmental-Requirement' }, + { text: '安装包获取', link: 'Get-Installation-Package' }, + { text: '部署指导', link: 'Deployment-Guide' }, + { text: 'docker部署', link: 'Docker-Install' }, + { text: '安全控制', link: 'Security-Management' }, + ], + }, + + { + text: '使用手册', + collapsible: true, + prefix: 'User-Manuel/', + // children: 'structure', + children: [ + { text: '语法约定', link: 'Syntax-Rule' }, + { text: '元数据管理', link: 'Operate-Metadata' }, + { text: '数据增删', link: 'Write-Delete-Data' }, + { text: '数据查询', link: 'Query-Data' }, + { text: '运算符和表达式', link: 'Operator-and-Expression' }, + { text: '数据库编程', link: 'Database-Programming' }, + { text: '权限管理', link: 'Authority-Management' }, + ], + }, + { + text: '工具体系', + collapsible: true, + prefix: 'Tools-System/', + // children: 'structure', + children: [ + { text: '命令行工具', link: 'CLI' }, + { text: '控制台工具', link: 'Workbench' }, + { text: '监控工具', link: 'Monitor-Tool' }, + { text: '测试工具', link: 'Benchmark' }, + { text: '运维工具', link: 'Maintenance-Tool' }, + { text: '导入导出工具', link: 'Import-Export-Tool' }, + ], + }, + { + text: '应用编程接口', + collapsible: true, + prefix: 'API/', + // children: 'structure', + children: [ + { text: 'Java 原生接口', link: 'Programming-Java-Native-API' }, + { text: 'Python', link: 'Programming-Python-Native-API' }, + { text: 'C++', link: 'Programming-Cpp-Native-API' }, + { text: 'Go', link: 'Programming-Go-Native-API' }, + { text: 'MQTT', link: 'Programming-MQTT' }, + { text: 'REST API V1', link: 'RestServiceV1' }, + { text: 'REST API V2', link: 'RestServiceV2' }, + { text: 'TsFile API', link: 'Programming-TsFile-API' }, + ], + }, + { + text: '系统集成', + collapsible: true, + prefix: 'Ecosystem-Integration/', + // children: 'structure', + children: [ + { text: 'Grafana-Plugin', link: 'Grafana-Plugin' }, + { text: 'Grafana-IoTDB-Connector', link: 'Grafana-Connector' }, + { text: 'Zeppelin-IoTDB-Connector', link: 'Zeppelin-IoTDB' }, + { text: 'Spark-TsFile-Connector', link: 'Spark-TsFile' }, + { text: 'Spark-IoTDB-Connector', link: 'Spark-IoTDB' }, + { text: 'Hive-TsFile-Connector', link: 'Hive-TsFile' }, + { text: 'Flink-IoTDB-Connector', link: 'Flink-IoTDB' }, + { text: 'Flink-TsFile-Connector', link: 'Flink-TsFile' }, + { text: 'NiFi-IoTDB-Connector', link: 'NiFi-IoTDB' }, + { text: 'DBeaver-IoTDB 集成方案', link: 'DBeaver' }, + ], + }, + { + text: 'SQL手册', + collapsible: true, + prefix: 'SQL-Manual/', + // children: 'structure', + children: [ + { text: 'SQL手册', link: 'SQL-Manual' }, + ], + }, + { + text: 'FAQ', + collapsible: true, + prefix: 'FAQ/', + // children: 'structure', + children: [ + { text: '常见问题', link: 'Frequently-asked-questions' }, ], + }, + { + text: '参考', + collapsible: true, + prefix: 'Reference/', + // children: 'structure', + children: [ + { text: '配置参数', link: 'Common-Config-Manual' }, + { text: '状态码', link: 'Status-Codes' }, + { text: '关键字', link: 'Keywords' }, + ], + }, + ], +}; diff --git a/src/.vuepress/utils/index.ts b/src/.vuepress/sidebar_timecho/en.ts similarity index 70% copy from src/.vuepress/utils/index.ts copy to src/.vuepress/sidebar_timecho/en.ts index 002eff5..3cc17c9 100644 --- a/src/.vuepress/utils/index.ts +++ b/src/.vuepress/sidebar_timecho/en.ts @@ -17,9 +17,13 @@ under the License. */ -export * from './define.js'; -export * from './editLink.js'; -export * from './typings.js'; +import { sidebar } from 'vuepress-theme-hope'; +import { enSidebar as V101xSidebar } from './V1.1.x/en.js'; +import { enSidebar as V100xSidebar } from './V1.0.x/en.js'; +import { enSidebar as V013xSidebar } from './V0.13.x/en.js'; -export const defaultVersion = 'V1.1.x'; -export const defaultBranch = 'rel/1.1'; +export const enSidebar = sidebar({ + ...V101xSidebar, + ...V100xSidebar, + ...V013xSidebar, +}); diff --git a/src/.vuepress/utils/index.ts b/src/.vuepress/sidebar_timecho/index.ts similarity index 82% copy from src/.vuepress/utils/index.ts copy to src/.vuepress/sidebar_timecho/index.ts index 002eff5..4493c7e 100644 --- a/src/.vuepress/utils/index.ts +++ b/src/.vuepress/sidebar_timecho/index.ts @@ -17,9 +17,5 @@ under the License. */ -export * from './define.js'; -export * from './editLink.js'; -export * from './typings.js'; - -export const defaultVersion = 'V1.1.x'; -export const defaultBranch = 'rel/1.1'; +export * from './en.js'; +export * from './zh.js'; diff --git a/src/.vuepress/utils/index.ts b/src/.vuepress/sidebar_timecho/zh.ts similarity index 70% copy from src/.vuepress/utils/index.ts copy to src/.vuepress/sidebar_timecho/zh.ts index 002eff5..b56f527 100644 --- a/src/.vuepress/utils/index.ts +++ b/src/.vuepress/sidebar_timecho/zh.ts @@ -17,9 +17,13 @@ under the License. */ -export * from './define.js'; -export * from './editLink.js'; -export * from './typings.js'; +import { sidebar } from 'vuepress-theme-hope'; +import { zhSidebar as V101xSidebar } from './V1.1.x/zh.js'; +import { zhSidebar as V100xSidebar } from './V1.0.x/zh.js'; +import { zhSidebar as V013xSidebar } from './V0.13.x/zh.js'; -export const defaultVersion = 'V1.1.x'; -export const defaultBranch = 'rel/1.1'; +export const zhSidebar = sidebar({ + ...V101xSidebar, + ...V100xSidebar, + ...V013xSidebar, +}); diff --git a/src/.vuepress/styles/index.scss b/src/.vuepress/styles/index.scss index a21c8ce..75b9872 100644 --- a/src/.vuepress/styles/index.scss +++ b/src/.vuepress/styles/index.scss @@ -51,4 +51,7 @@ td a span{ display: none; +} +h1, h2, h3, h4, h5, h6 { + font-family: var(--font-family) } \ No newline at end of file diff --git a/src/.vuepress/utils/index.ts b/src/.vuepress/utils/index.ts index 002eff5..f39d5a5 100644 --- a/src/.vuepress/utils/index.ts +++ b/src/.vuepress/utils/index.ts @@ -21,5 +21,5 @@ export * from './define.js'; export * from './editLink.js'; export * from './typings.js'; -export const defaultVersion = 'V1.1.x'; -export const defaultBranch = 'rel/1.1'; +export const defaultVersion = 'V1.2.x'; +export const defaultBranch = 'rel/1.2';
