Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(init v1.3) #126

Merged
merged 7 commits into from
Dec 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6,992 changes: 3,033 additions & 3,959 deletions package-lock.json

Large diffs are not rendered by default.

33 changes: 18 additions & 15 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,28 @@
"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix"
},
"devDependencies": {
"@rushstack/eslint-patch": "^1.3.2",
"@vue/eslint-config-airbnb-with-typescript": "^7.0.0",
"@vuepress/client": "2.0.0-beta.66",
"@vuepress/plugin-docsearch": "2.0.0-beta.66",
"@vuepress/plugin-google-analytics": "2.0.0-beta.66",
"@vuepress/utils": "2.0.0-beta.66",
"element-plus": "^2.3.8",
"eslint": "^8.44.0",
"eslint-plugin-vue": "^9.15.1",
"gh-pages": "^5.0.0",
"vue": "^3.3.4",
"vuepress": "2.0.0-beta.66",
"vuepress-plugin-redirect": "2.0.0-beta.233",
"vuepress-theme-hope": "2.0.0-beta.233"
"@rushstack/eslint-patch": "^1.6.0",
"@vue/eslint-config-airbnb-with-typescript": "^7.0.1",
"@vuepress/client": "2.0.0-rc.0",
"@vuepress/plugin-docsearch": "2.0.0-rc.0",
"@vuepress/plugin-google-analytics": "2.0.0-rc.0",
"@vuepress/utils": "2.0.0-rc.0",
"element-plus": "^2.4.3",
"eslint": "^8.55.0",
"eslint-plugin-vue": "^9.19.2",
"gh-pages": "^6.1.0",
"vue": "^3.3.10",
"vuepress": "2.0.0-rc.0",
"vuepress-plugin-redirect": "2.0.0-rc.2",
"vuepress-theme-hope": "2.0.0-rc.2"
},
"licenses": [
{
"type": "Apache-2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0"
}
]
],
"dependencies": {
"@vue/repl": "^3.0.0"
}
}
1 change: 1 addition & 0 deletions src/.vuepress/navbar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export const enNavbar = navbar([
text: 'Documentation',
children: [
// { text: 'latest', link: '/UserGuide/Master/QuickStart/QuickStart' },
// { text: 'v1.3.x', link: '/UserGuide/V1.3.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' },
Expand Down
1 change: 1 addition & 0 deletions src/.vuepress/navbar/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export const zhNavbar = navbar([
text: '文档',
children: [
// { text: 'latest', link: '/zh/UserGuide/Master/QuickStart/QuickStart' },
// { text: 'v1.3.x', link: '/zh/UserGuide/V1.3.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' },
Expand Down
178 changes: 178 additions & 0 deletions src/.vuepress/sidebar/V1.3.x/en.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
/*
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.3.x/': [
{
text: 'IoTDB User Guide (V1.3.x)',
children: [],
},
{
text: 'About IoTDB',
collapsible: true,
prefix: 'IoTDB-Introduction/',
// children: 'structure',
children: [
{ text: 'What is IoTDB', link: 'What-is-IoTDB' },
{ text: 'Features', link: 'Features' },
{ text: 'Architecture', link: 'Architecture' },
{ text: 'Performance', link: 'Performance' },
{ text: 'Scenario', link: 'Scenario' },
{ 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: 'General SQL Statements', link: 'General-SQL-Statements' },
],
},
{
text: 'Basic Concept',
collapsible: true,
prefix: 'Basic-Concept/',
// children: 'structure',
children: [
{ text: 'Data Model and Terminology', link: 'Data-Model-and-Terminology' },
{ text: 'Data Type', link: 'Data-Type' },
{ text: 'Encoding and Compression', link: 'Encoding-and-Compression' },
{ text: 'Data Partitioning & Load Balancing', link: 'Cluster-data-partitioning' },
],
},
{
text: 'Deployment & Maintenance',
collapsible: true,
prefix: 'Deployment-and-Maintenance/',
// children: 'structure',
children: [
{ text: 'Environmental Requirement', link: 'Environmental-Requirement' },
{ text: 'Resource Recommendation', link: 'Deployment-Recommendation' },
{ text: 'Deployment Guide', link: 'Deployment-Guide' },
{ text: 'Docker Install', link: 'Docker-Install' },
{ text: 'Monitoring-Board-Install-and-Deploy', link: 'Monitoring-Board-Install-and-Deploy' },
],
},

{
text: 'User Manual',
collapsible: true,
prefix: 'User-Manual/',
// children: 'structure',
children: [
{ text: 'Syntax Rule', link: 'Syntax-Rule' },
{ text: 'Operate Metadata', link: 'Operate-Metadata' },
{ text: 'Write Delete Data', link: 'Write-Delete-Data' },
{ text: 'Query Data', link: 'Query-Data' },
{ text: 'Operator and Expression', link: 'Operator-and-Expression' },
{ text: 'Streaming', link: 'Streaming' },
{ text: 'Data Sync', link: 'Data-Sync' },
{ text: 'Database Programming', link: 'Database-Programming' },
{ text: 'Authority Management', link: 'Authority-Management' },
],
},
{
text: 'Tools System',
collapsible: true,
prefix: 'Tools-System/',
// children: 'structure',
children: [
{ text: 'CLI', link: 'CLI' },
{ text: 'Workbench', link: 'Workbench' },
{ text: 'Monitor Tool', link: 'Monitor-Tool' },
{ text: 'Benchmark', link: 'Benchmark' },
{ text: 'Maintenance Tool', link: 'Maintenance-Tool' },
{ text: 'Import Export Tool', link: 'Import-Export-Tool' },
],
},
{
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: 'C# Native API', link: 'Programming-CSharp-Native-API' },
{ text: 'Node.js Native API', link: 'Programming-NodeJS-Native-API' },
{ text: 'Rust Native API', link: 'Programming-Rust-Native-API' },
{ text: 'JDBC (Not Recommend)', link: 'Programming-JDBC' },
{ text: 'MQTT', link: 'Programming-MQTT' },
{ text: 'Kafka', link: 'Programming-Kafka' },
{ text: 'REST API V1 (Not Recommend)', link: 'RestServiceV1' },
{ text: 'REST API V2', link: 'RestServiceV2' },
{ text: 'TsFile API', link: 'Programming-TsFile-API' },
],
},
{
text: 'Ecosystem Integration',
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 SQL IoTDB Connector', link: 'Flink-SQL-IoTDB' },
{ text: 'Flink TsFile Connector', link: 'Flink-TsFile' },
{ text: 'NiFi IoTDB Connector', link: 'NiFi-IoTDB' },
{ text: 'DBeaver-IoTDB', link: 'DBeaver' },
],
},
{
text: 'SQL Manual',
collapsible: true,
prefix: 'SQL-Manual/',
// children: 'structure',
children: [
{ text: 'SQL Manual', link: 'SQL-Manual' },
],
},
{
text: 'FAQ',
collapsible: true,
prefix: 'FAQ/',
// children: 'structure',
children: [
{ text: 'Frequently Asked Questions', link: 'Frequently-asked-questions' }],
},
{
text: 'Reference',
collapsible: true,
prefix: 'Reference/',
// children: 'structure',
children: [
{ text: 'UDF Libraries', link: 'UDF-Libraries' },
{ text: 'Common Config Manual', link: 'Common-Config-Manual' },
{ text: 'Status Codes', link: 'Status-Codes' },
{ text: 'Keywords', link: 'Keywords' },
],
},
],
};
Loading