Skip to content

Commit 91f9ca9

Browse files
authored
Quickly get started with English document PR (#587)
1 parent b789834 commit 91f9ca9

File tree

14 files changed

+1588
-97
lines changed

14 files changed

+1588
-97
lines changed

src/.vuepress/sidebar/V2.0.x/en-Table.ts

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,17 @@ export const enSidebar = {
2222
text: 'IoTDB User Guide (V1.3.3)',
2323
children: [],
2424
},
25+
{
26+
text: 'Background knowledge',
27+
collapsible: true,
28+
prefix: 'Background-knowledge/',
29+
children: [
30+
{ text: 'Common Concepts', link: 'Cluster-Concept_apache' },
31+
{ text: 'Timeseries Data Model', link: 'Navigating_Time_Series_Data' },
32+
{ text: 'Modeling Scheme Design', link: 'Data-Model-and-Terminology_apache' },
33+
{ text: 'Data Type', link: 'Data-Type' },
34+
],
35+
},
2536
{
2637
text: 'Quick Start',
2738
link: 'QuickStart/QuickStart_apache',
@@ -74,16 +85,23 @@ export const enSidebar = {
7485
{ text: 'TTL Delete Data', link: 'TTL-Delete-Data' },
7586
],
7687
},
88+
],
89+
},
7790
],
7891
},
79-
92+
{
93+
text: 'Advanced Features',
94+
collapsible: true,
95+
prefix: 'User-Manual/',
96+
// children: 'structure',
97+
children: [
98+
{ text: 'Data Sync', link: 'Data-Sync_apache' },
8099
{
81-
text: 'Maintenance SQL',
100+
text: 'System Maintenance',
82101
collapsible: true,
83102
children: [
84103
{ text: 'Query Performance Analysis', link: 'Query-Performance-Analysis' },
85-
{ text: 'Load Balance', link: 'Load-Balance' },
86-
{ text: 'Data Recovery', link: 'Data-Recovery' },
104+
{ text: 'Maintenance statement', link: 'Maintenance-statement' },
87105
],
88106
},
89107
],
@@ -120,6 +138,24 @@ export const enSidebar = {
120138
{ text: 'LIMIT&OFFSET Clause', link: 'Limit-Offset-Clause' },
121139
],
122140
},
141+
{
142+
text: 'Functions and Operators',
143+
collapsible: true,
144+
children: [
145+
{ text: 'Basis Functions', link: 'Basis-Function' },
146+
{ text: 'Featured Functions', link: 'Featured-Functions' },
147+
],
148+
},
149+
],
150+
},
151+
{
152+
text: 'Technical Insider',
153+
collapsible: true,
154+
prefix: 'Technical-Insider/',
155+
// children: 'structure',
156+
children: [
157+
{ text: 'Compression & Encoding', link: 'Encoding-and-Compression' },
158+
{ text: 'Data Partitioning & Load Balancing', link: 'Cluster-data-partitioning' },
123159
],
124160
},
125161
{
@@ -128,8 +164,9 @@ export const enSidebar = {
128164
prefix: 'Reference/',
129165
// children: 'structure',
130166
children: [
131-
{ text: 'Config Manual', link: 'System-Config-Manual' },
132167
{ text: 'Sample Data', link: 'Sample-Data' },
168+
{ text: 'Config Manual', link: 'System-Config-Manual' },
169+
{ text: 'Status Codes', link: 'Status-Codes' },
133170
],
134171
},
135172
],

src/.vuepress/sidebar_timecho/V2.0.x/en-Table.ts

Lines changed: 69 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,28 @@ export const enSidebar = {
2222
text: 'IoTDB User Guide',
2323
children: [],
2424
},
25+
{
26+
text: 'About IoTDB',
27+
collapsible: true,
28+
prefix: 'IoTDB-Introduction/',
29+
// children: 'structure', 使用该方式自动获取文件夹下的文件
30+
children: [
31+
{ text: 'IoTDB Introduction', link: 'IoTDB-Introduction_timecho' },
32+
{ text: 'Scenario', link: 'Scenario' },
33+
{ text: 'Release history', link: 'Release-history_timecho' },
34+
],
35+
},
36+
{
37+
text: 'Background knowledge',
38+
collapsible: true,
39+
prefix: 'Background-knowledge/',
40+
children: [
41+
{ text: 'Common Concepts', link: 'Cluster-Concept_timecho' },
42+
{ text: 'Timeseries Data Model', link: 'Navigating_Time_Series_Data' },
43+
{ text: 'Modeling Scheme Design', link: 'Data-Model-and-Terminology_timecho' },
44+
{ text: 'Data Type', link: 'Data-Type' },
45+
],
46+
},
2547
{
2648
text: 'Quick Start',
2749
link: 'QuickStart/QuickStart_timecho',
@@ -74,16 +96,24 @@ export const enSidebar = {
7496
{ text: 'TTL Delete Data', link: 'TTL-Delete-Data' },
7597
],
7698
},
99+
],
100+
},
77101
],
78102
},
79-
103+
{
104+
text: 'Advanced Features',
105+
collapsible: true,
106+
prefix: 'User-Manual/',
107+
// children: 'structure',
108+
children: [
109+
{ text: 'Data Sync', link: 'Data-Sync_timecho' },
110+
{ text: 'Tiered Storage', link: 'Tiered-Storage_timecho' },
80111
{
81-
text: 'Maintenance SQL',
112+
text: 'System Maintenance',
82113
collapsible: true,
83114
children: [
84115
{ text: 'Query Performance Analysis', link: 'Query-Performance-Analysis' },
85-
{ text: 'Load Balance', link: 'Load-Balance' },
86-
{ text: 'Data Recovery', link: 'Data-Recovery' },
116+
{ text: 'Maintenance statement', link: 'Maintenance-statement' },
87117
],
88118
},
89119
],
@@ -95,6 +125,21 @@ export const enSidebar = {
95125
// children: 'structure',
96126
children: [
97127
{ text: 'CLI', link: 'CLI' },
128+
{ text: 'Monitor Tool', link: 'Monitor-Tool_timecho' },
129+
{ text: 'Benchmark Tool', link: 'Benchmark' },
130+
{ text: 'Cluster Management Tool', link: 'Maintenance-Tool_timecho' },
131+
],
132+
},
133+
{
134+
text: 'API',
135+
collapsible: true,
136+
prefix: 'API/',
137+
// children: 'structure',
138+
children: [
139+
{ text: 'Java Native API', link: 'Programming-Java-Native-API' },
140+
{ text: 'Python Native API', link: 'Programming-Python-Native-API' },
141+
{ text: 'JDBC', link: 'Programming-JDBC' },
142+
{ text: 'RESTAPI V1 ', link: 'RestServiceV1' },
98143
],
99144
},
100145
{
@@ -120,6 +165,24 @@ export const enSidebar = {
120165
{ text: 'LIMIT&OFFSET Clause', link: 'Limit-Offset-Clause' },
121166
],
122167
},
168+
{
169+
text: 'Functions and Operators',
170+
collapsible: true,
171+
children: [
172+
{ text: 'Basis Functions', link: 'Basis-Function' },
173+
{ text: 'Featured Functions', link: 'Featured-Functions' },
174+
],
175+
},
176+
],
177+
},
178+
{
179+
text: 'Technical Insider',
180+
collapsible: true,
181+
prefix: 'Technical-Insider/',
182+
// children: 'structure',
183+
children: [
184+
{ text: 'Compression & Encoding', link: 'Encoding-and-Compression' },
185+
{ text: 'Data Partitioning & Load Balancing', link: 'Cluster-data-partitioning' },
123186
],
124187
},
125188
{
@@ -128,8 +191,9 @@ export const enSidebar = {
128191
prefix: 'Reference/',
129192
// children: 'structure',
130193
children: [
131-
{ text: 'Config Manual', link: 'System-Config-Manual' },
132194
{ text: 'Sample Data', link: 'Sample-Data' },
195+
{ text: 'Config Manual', link: 'System-Config-Manual' },
196+
{ text: 'Status Codes', link: 'Status-Codes' },
133197
],
134198
},
135199
],
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
22+
# Quick Start
23+
24+
This document will guide you through methods to get started quickly with IoTDB.
25+
26+
## How to Install and Deploy?
27+
28+
This guide will assist you in quickly installing and deploying IoTDB. You can quickly navigate to the content you need to review through the following document links:
29+
30+
1. Prepare the necessary machine resources: The deployment and operation of IoTDB require consideration of various aspects of machine resource configuration. For specific resource configurations, please refer to [Database Resource](../Deployment-and-Maintenance/Database-Resources.md)
31+
32+
2. Complete system configuration preparations: IoTDB's system configuration involves multiple aspects. For an introduction to key system configurations, please see [System Requirements](../Deployment-and-Maintenance/Environment-Requirements.md)
33+
34+
3. Obtain the installation package: You can obtain the IoTDB installation package on the [Apache IoTDB official website](https://iotdb.apache.org/zh/Download/).For the specific structure of the installation package, please refer to[Obtain TimechoDB](../Deployment-and-Maintenance/IoTDB-Package_apache.md)
35+
36+
4. Install the database and activate it: Depending on your actual deployment architecture, you can choose from the following tutorials for installation and deployment:
37+
38+
- Stand-Alone Deployment: [Stand-Alone Deployment ](../Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md)
39+
40+
- Cluster Deployment:[Cluster Deployment](../Deployment-and-Maintenance/Cluster-Deployment_apache.md)
41+
42+
> ❗️Note: We currently still recommend direct installation and deployment on physical/virtual machines. For Docker deployment, please refer to [Docker Deployment](../Deployment-and-Maintenance/Docker-Deployment_apache.md)
43+
44+
## How to Use IoTDB?
45+
46+
1. Database Modeling Design: Database modeling is a crucial step in creating a database system, involving the design of data structures and relationships to ensure that the organization of data meets the needs of specific applications. The following documents will help you quickly understand IoTDB's modeling design:
47+
48+
- Introduction to Time Series Concepts: [Navigating Time Series Data](../Background-knowledge/Navigating_Time_Series_Data.md)
49+
50+
- Introduction to Modeling Design:[Data Model and Terminology](../Background-knowledge/Data-Model-and-Terminology_apache.md)
51+
52+
- Introduction to Database:[Database Management](../Basic-Concept/Database-Management.md)
53+
54+
- Introduction to Tables: [Table Management](../Basic-Concept/Table-Management.md)
55+
56+
2. Data Insertion & Updates: IoTDB provides multiple methods for inserting real-time data. For basic data insertion and updating operations, please see [Write&Updata Data](../Basic-Concept/Write-Updata-Data.md)
57+
58+
3. Data Querying: IoTDB offers a rich set of data querying capabilities. For a basic introduction to data querying, please see [Query Data](../Basic-Concept/Query-Data.md)
59+
60+
4. Data Deletion: IoTDB supports two deletion methods: SQL-based deletion and automatic expiration deletion (TTL).
61+
62+
- SQL-Based Deletion: For a basic introduction, please refer to [Delete Data](../Basic-Concept/Delete-Data.md)
63+
64+
- Automatic Expiration Deletion (TTL): For a basic introduction, please see [TTL Delete Data](../Basic-Concept/TTL-Delete-Data.md)
65+
66+
5. Advanced Features: In addition to common database functions such as insertion and querying, IoTDB also supports features like "data synchronization." For specific usage methods, please refer to the respective documents:
67+
68+
- Data Synchronization: [Data Sync](../User-Manual/Data-Sync_apache.md)
69+
70+
6. Application Programming Interfaces (APIs): IoTDB provides various application programming interfaces (APIs) to facilitate developers' interaction with IoTDB in applications. Currently supported interfaces include [Java Native API](../API/Programming-Java-Native-API.md)[Python Native API](../API/Programming-Python-Native-API.md)[JDBC](../API/Programming-JDBC.md), and more. For more programming interfaces, please refer to the [Application Programming Interfaces] section on the official website.
71+
72+
## Want to learn more technical details?
73+
74+
If you want to explore IoTDB’s internal mechanisms further, refer to the following documents:
75+
76+
- Data Partitioning and Load Balancing: IoTDB is designed with a partitioning strategy and load balancing algorithm to enhance cluster availability and performance. For more details, please see [Cluster data partitioning](../Technical-Insider/Cluster-data-partitioning.md)
77+
78+
- Compression & Encoding: IoTDB employs various encoding and compression techniques optimized for different data types to improve storage efficiency. For more details, please see [Encoding and Compression](../Technical-Insider/Encoding-and-Compression.md)

src/UserGuide/Master/Table/QuickStart/QuickStart_timecho.md

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,76 @@
1919
2020
-->
2121

22-
**Comming Soon**
22+
# Quick Start
23+
24+
This document will guide you through methods to get started quickly with IoTDB.
25+
26+
## How to Install and Deploy?
27+
28+
This guide will assist you in quickly installing and deploying IoTDB. You can quickly navigate to the content you need to review through the following document links:
29+
30+
1. Prepare the necessary machine resources: The deployment and operation of IoTDB require consideration of various aspects of machine resource configuration. For specific resource configurations, please refer to [Database Resource](../Deployment-and-Maintenance/Database-Resources.md)
31+
32+
2. Complete system configuration preparations: IoTDB's system configuration involves multiple aspects. For an introduction to key system configurations, please see [System Requirements](../Deployment-and-Maintenance/Environment-Requirements.md)
33+
34+
3. Obtain the installation package: You can contact the Timecho Team to get the IoTDB installation package to ensure you download the latest and most stable version. For the specific structure of the installation package, please refer to[Obtain TimechoDB](../Deployment-and-Maintenance/IoTDB-Package_timecho.md)
35+
36+
4. Install the database and activate it: Depending on your actual deployment architecture, you can choose from the following tutorials for installation and deployment:
37+
38+
- Stand-Alone Deployment: [Stand-Alone Deployment ](../Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md)
39+
40+
- Cluster Deployment:[Cluster Deployment](../Deployment-and-Maintenance/Cluster-Deployment_timecho.md)
41+
42+
- Dual-Active Deployment:[Dual-Active Deployment](../Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md)
43+
44+
> ❗️Note: We currently still recommend direct installation and deployment on physical/virtual machines. For Docker deployment, please refer to [Docker Deployment](../Deployment-and-Maintenance/Docker-Deployment_timecho.md)
45+
46+
5. Install supporting tools: The TimechoDB provides supporting tools such as a monitoring panel, which is recommended to be installed when deploying the TimechoDB to facilitate a more convenient usage:
47+
48+
- Monitoring Panel: Provides hundreds of database monitoring metrics for fine-grained monitoring of IoTDB and its operating system, assisting in system optimization, performance tuning, and bottleneck detection. For installation steps, please see [Monitoring-panel Deployment ](../Deployment-and-Maintenance/Monitoring-panel-deployment.md)
49+
50+
51+
## How to Use IoTDB?
52+
53+
1. Database Modeling Design: Database modeling is a crucial step in creating a database system, involving the design of data structures and relationships to ensure that the organization of data meets the needs of specific applications. The following documents will help you quickly understand IoTDB's modeling design:
54+
55+
- Introduction to Time Series Concepts: [Navigating Time Series Data](../Background-knowledge/Navigating_Time_Series_Data.md)
56+
57+
- Introduction to Modeling Design:[Data Model and Terminology](../Background-knowledge/Data-Model-and-Terminology_timecho.md)
58+
59+
- Introduction to Database:[Database Management](../Basic-Concept/Database-Management.md)
60+
61+
- Introduction to Tables: [Table Management](../Basic-Concept/Table-Management.md)
62+
63+
2. Data Insertion & Updates: IoTDB provides multiple methods for inserting real-time data. For basic data insertion and updating operations, please see [Write&Updata Data](../Basic-Concept/Write-Updata-Data.md)
64+
65+
3. Data Querying: IoTDB offers a rich set of data querying capabilities. For a basic introduction to data querying, please see [Query Data](../Basic-Concept/Query-Data.md)
66+
67+
4. Data Deletion: IoTDB supports two deletion methods: SQL-based deletion and automatic expiration deletion (TTL).
68+
69+
- SQL-Based Deletion: For a basic introduction, please refer to [Delete Data](../Basic-Concept/Delete-Data.md)
70+
71+
- Automatic Expiration Deletion (TTL): For a basic introduction, please see [TTL Delete Data](../Basic-Concept/TTL-Delete-Data.md)
72+
73+
5. Advanced Features: In addition to common database functions such as insertion and querying, IoTDB also supports features like "data synchronization." For specific usage methods, please refer to the respective documents:
74+
75+
- Data Synchronization: [Data Sync](../User-Manual/Data-Sync_timecho.md)
76+
77+
6. Application Programming Interfaces (APIs): IoTDB provides various application programming interfaces (APIs) to facilitate developers' interaction with IoTDB in applications. Currently supported interfaces include [Java Native API](../API/Programming-Java-Native-API.md)[Python Native API](../API/Programming-Python-Native-API.md)[JDBC](../API/Programming-JDBC.md), and more. For more programming interfaces, please refer to the [Application Programming Interfaces] section on the official website.
78+
79+
## What other convenient peripheral tools are available?
80+
81+
In addition to its own rich features, IoTDB is complemented by a comprehensive suite of peripheral tools. This guide will help you quickly understand and use these tools:
82+
83+
- Monitoring Panel: A tool for detailed monitoring of IoTDB and its operating system, covering hundreds of database monitoring indicators such as database performance and system resources, helping system optimization and bottleneck identification. For a detailed usage introduction, please refer to [Monitor Tool](../Tools-System/Monitor-Tool_timecho.md)
84+
85+
86+
## Want to learn more technical details?
87+
88+
If you want to explore IoTDB’s internal mechanisms further, refer to the following documents:
89+
90+
- Data Partitioning and Load Balancing: IoTDB is designed with a partitioning strategy and load balancing algorithm to enhance cluster availability and performance. For more details, please see [Cluster data partitioning](../Technical-Insider/Cluster-data-partitioning.md)
91+
92+
- Compression & Encoding: IoTDB employs various encoding and compression techniques optimized for different data types to improve storage efficiency. For more details, please see [Encoding and Compression](../Technical-Insider/Encoding-and-Compression.md)
93+
94+

0 commit comments

Comments
 (0)