From ea1776212e4c21bb0a904c00f578a8d0f93bd321 Mon Sep 17 00:00:00 2001 From: gccgdb1234 Date: Fri, 26 Aug 2022 11:01:19 +0800 Subject: [PATCH] doc: refine description for all pages --- docs/en/05-develop/01-connect/01-python.md | 1 + docs/en/05-develop/01-connect/02-java.md | 1 + docs/en/05-develop/01-connect/03-go.md | 1 + docs/en/05-develop/01-connect/04-rust.md | 1 + docs/en/05-develop/01-connect/05-node.md | 1 + docs/en/05-develop/01-connect/09-rest-api.md | 1 + docs/en/05-develop/02-model.md | 1 + docs/en/06-replication/index.md | 2 +- docs/en/08-data-in/01-insert-data.md | 2 +- docs/en/08-data-in/02-prometheus.md | 2 +- docs/en/08-data-in/03-telegraf.md | 2 +- docs/en/09-data-out/01-query.data.md | 2 +- docs/en/09-data-out/04-taosdump.md | 2 +- docs/en/12-taos-sql/04-stable.md | 1 + docs/en/12-taos-sql/05-insert.md | 1 + docs/en/12-taos-sql/06-select.md | 1 + docs/en/12-taos-sql/10-function.md | 1 + docs/en/12-taos-sql/12-distinguished.md | 1 + docs/en/12-taos-sql/13-tmq.md | 1 + docs/en/12-taos-sql/14-stream.md | 1 + docs/en/12-taos-sql/16-operators.md | 1 + docs/en/12-taos-sql/17-json.md | 1 + docs/en/12-taos-sql/18-escape.md | 1 + docs/en/12-taos-sql/19-limit.md | 5 +++-- docs/en/12-taos-sql/20-keywords.md | 3 ++- docs/en/12-taos-sql/26-udf.md | 3 ++- docs/en/12-taos-sql/27-index.md | 1 + docs/en/17-tools/03-taosbenchmark.md | 1 + docs/en/20-faq.md | 1 - 29 files changed, 32 insertions(+), 11 deletions(-) delete mode 100644 docs/en/20-faq.md diff --git a/docs/en/05-develop/01-connect/01-python.md b/docs/en/05-develop/01-connect/01-python.md index 9781bfe1ec..3704fc8883 100644 --- a/docs/en/05-develop/01-connect/01-python.md +++ b/docs/en/05-develop/01-connect/01-python.md @@ -1,6 +1,7 @@ --- sidebar_label: Python title: Connect with Python Connector +description: Python Connector for TDengine. --- import Tabs from '@theme/Tabs'; diff --git a/docs/en/05-develop/01-connect/02-java.md b/docs/en/05-develop/01-connect/02-java.md index 651de9e553..87a91e7b14 100644 --- a/docs/en/05-develop/01-connect/02-java.md +++ b/docs/en/05-develop/01-connect/02-java.md @@ -1,6 +1,7 @@ --- sidebar_label: Java title: Connect with Java Connector +description: Java Connector for TDengine. --- import Tabs from '@theme/Tabs'; diff --git a/docs/en/05-develop/01-connect/03-go.md b/docs/en/05-develop/01-connect/03-go.md index 3caf7ca7ba..267e0e99ac 100644 --- a/docs/en/05-develop/01-connect/03-go.md +++ b/docs/en/05-develop/01-connect/03-go.md @@ -1,6 +1,7 @@ --- sidebar_label: Go title: Connect with Go Connector +description: Go Connector for TDengine. --- import Tabs from '@theme/Tabs'; diff --git a/docs/en/05-develop/01-connect/04-rust.md b/docs/en/05-develop/01-connect/04-rust.md index 2c195d5d58..ad20066941 100644 --- a/docs/en/05-develop/01-connect/04-rust.md +++ b/docs/en/05-develop/01-connect/04-rust.md @@ -1,6 +1,7 @@ --- sidebar_label: Rust title: Connect with Rust Connector +description: Rust Connector for TDengine --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/en/05-develop/01-connect/05-node.md b/docs/en/05-develop/01-connect/05-node.md index 5f13df643c..d88e4ec855 100644 --- a/docs/en/05-develop/01-connect/05-node.md +++ b/docs/en/05-develop/01-connect/05-node.md @@ -1,6 +1,7 @@ --- sidebar_label: Node.js title: Connect with Node.js Connector +description: Node.JS Connector for TDengine --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/en/05-develop/01-connect/09-rest-api.md b/docs/en/05-develop/01-connect/09-rest-api.md index b2dd9a6f15..67df887906 100644 --- a/docs/en/05-develop/01-connect/09-rest-api.md +++ b/docs/en/05-develop/01-connect/09-rest-api.md @@ -1,6 +1,7 @@ --- sidebar_label: REST API title: REST API +description: Communicate with TDengine Cloud Service through RESTful API --- ## Config diff --git a/docs/en/05-develop/02-model.md b/docs/en/05-develop/02-model.md index 86853aaaa3..99730707cd 100644 --- a/docs/en/05-develop/02-model.md +++ b/docs/en/05-develop/02-model.md @@ -1,5 +1,6 @@ --- title: Data Model +desription: Typical Data Model used in TDengine --- The data model employed by TDengine is similar to that of a relational database. You have to create databases and tables. You must design the data model based on your own business and application requirements. You should design the STable (an abbreviation for super table) schema to fit your data. This chapter will explain the big picture without getting into syntactical details. diff --git a/docs/en/06-replication/index.md b/docs/en/06-replication/index.md index 42e0049508..2b451ed6c4 100644 --- a/docs/en/06-replication/index.md +++ b/docs/en/06-replication/index.md @@ -1,7 +1,7 @@ --- sidebar_label: Data Replication title: Data Replication -description: Briefly introduce how to replicate data among TDengine cloud services +description: Replicate data between TDengine cloud services --- TDengine provides full support for data replication. You can replicate data from TDengine cloud service to local TDengine, from local TDengine to TDengine cloud service, or from one cloud service to another one and it doesn't matter which cloud or region the two services reside in. \ No newline at end of file diff --git a/docs/en/08-data-in/01-insert-data.md b/docs/en/08-data-in/01-insert-data.md index 891f3cdbf3..4ccbbc8080 100644 --- a/docs/en/08-data-in/01-insert-data.md +++ b/docs/en/08-data-in/01-insert-data.md @@ -1,7 +1,7 @@ --- sidebar_label: SQL title: Insert Data Using SQL -description: This section describes how to insert data using TDengine SQL +description: Insert data using TDengine SQL --- # Insert Data diff --git a/docs/en/08-data-in/02-prometheus.md b/docs/en/08-data-in/02-prometheus.md index 9c11e0d609..e4e670aae1 100644 --- a/docs/en/08-data-in/02-prometheus.md +++ b/docs/en/08-data-in/02-prometheus.md @@ -1,7 +1,7 @@ --- sidebar_label: Prometheus title: Prometheus for TDengine Cloud -description: This topic introduces how to write data into TDengine from Prometheus. +description: Write data into TDengine from Prometheus. --- Prometheus is a widespread open-source monitoring and alerting system. Prometheus joined the Cloud Native Computing Foundation (CNCF) in 2016 as the second incubated project after Kubernetes, which has a very active developer and user community. diff --git a/docs/en/08-data-in/03-telegraf.md b/docs/en/08-data-in/03-telegraf.md index 2dc6aa3556..69ae2eeb68 100644 --- a/docs/en/08-data-in/03-telegraf.md +++ b/docs/en/08-data-in/03-telegraf.md @@ -1,7 +1,7 @@ --- sidebar_label: Telegraf title: Telegraf for TDengine Cloud -description: This section explains how to write data into TDengine from telegraf. +description: Write data into TDengine from telegraf. --- Telegraf is an open-source, metrics collection software. Telegraf can collect the operation information of various components without having to write any scripts to collect regularly, reducing the difficulty of data acquisition. diff --git a/docs/en/09-data-out/01-query.data.md b/docs/en/09-data-out/01-query.data.md index 3bf94d1fe4..b6958860bb 100644 --- a/docs/en/09-data-out/01-query.data.md +++ b/docs/en/09-data-out/01-query.data.md @@ -1,7 +1,7 @@ --- sidebar_label: SQL title: Query Data Using SQL -description: This topic introduces how to read data from TDengine using basic SQL. +description: Read data from TDengine using basic SQL. --- # Query Data diff --git a/docs/en/09-data-out/04-taosdump.md b/docs/en/09-data-out/04-taosdump.md index 4df8700170..131ec1d35c 100644 --- a/docs/en/09-data-out/04-taosdump.md +++ b/docs/en/09-data-out/04-taosdump.md @@ -1,7 +1,7 @@ --- sidebar_label: taosDump title: Dump Data Using taosDump -description: Introduces how to dump data from TDengine into files using taosDump +description: Dump data from TDengine into files using taosDump --- # taosDump diff --git a/docs/en/12-taos-sql/04-stable.md b/docs/en/12-taos-sql/04-stable.md index 6a0a0922cc..dbeda21c2b 100644 --- a/docs/en/12-taos-sql/04-stable.md +++ b/docs/en/12-taos-sql/04-stable.md @@ -1,6 +1,7 @@ --- sidebar_label: Supertable title: Supertable +description: Operations about Super Tables. --- ## Create a Supertable diff --git a/docs/en/12-taos-sql/05-insert.md b/docs/en/12-taos-sql/05-insert.md index e7d56fb3c7..e798d1f804 100644 --- a/docs/en/12-taos-sql/05-insert.md +++ b/docs/en/12-taos-sql/05-insert.md @@ -1,6 +1,7 @@ --- sidebar_label: Insert title: Insert +description: Insert data into TDengine --- ## Syntax diff --git a/docs/en/12-taos-sql/06-select.md b/docs/en/12-taos-sql/06-select.md index 1dd0caed38..cf35c5b755 100644 --- a/docs/en/12-taos-sql/06-select.md +++ b/docs/en/12-taos-sql/06-select.md @@ -1,6 +1,7 @@ --- sidebar_label: Select title: Select +description: Query Data from TDengine. --- ## Syntax diff --git a/docs/en/12-taos-sql/10-function.md b/docs/en/12-taos-sql/10-function.md index d35fd31099..f19e13f638 100644 --- a/docs/en/12-taos-sql/10-function.md +++ b/docs/en/12-taos-sql/10-function.md @@ -2,6 +2,7 @@ sidebar_label: Functions title: Functions toc_max_heading_level: 4 +description: TDengine Built-in Functions. --- ## Single Row Functions diff --git a/docs/en/12-taos-sql/12-distinguished.md b/docs/en/12-taos-sql/12-distinguished.md index 707089abe5..e816fe615e 100644 --- a/docs/en/12-taos-sql/12-distinguished.md +++ b/docs/en/12-taos-sql/12-distinguished.md @@ -1,6 +1,7 @@ --- sidebar_label: Time-Series Extensions title: Time-Series Extensions +description: TimeSeries Data Specific Queries. --- As a purpose-built database for storing and processing time-series data, TDengine provides time-series-specific extensions to standard SQL. diff --git a/docs/en/12-taos-sql/13-tmq.md b/docs/en/12-taos-sql/13-tmq.md index befab4f4f0..33122e770e 100644 --- a/docs/en/12-taos-sql/13-tmq.md +++ b/docs/en/12-taos-sql/13-tmq.md @@ -1,6 +1,7 @@ --- sidebar_label: Data Subscription title: Data Subscription +description: Subscribe Data from TDengine. --- The information in this document is related to the TDengine data subscription feature. diff --git a/docs/en/12-taos-sql/14-stream.md b/docs/en/12-taos-sql/14-stream.md index fcd7876510..d26adc9c7f 100644 --- a/docs/en/12-taos-sql/14-stream.md +++ b/docs/en/12-taos-sql/14-stream.md @@ -1,6 +1,7 @@ --- sidebar_label: Stream Processing title: Stream Processing +description: Built-in Stream Processing. --- Raw time-series data is often cleaned and preprocessed before being permanently stored in a database. Stream processing components like Kafka, Flink, and Spark are often deployed alongside a time-series database to handle these operations, increasing system complexity and maintenance costs. diff --git a/docs/en/12-taos-sql/16-operators.md b/docs/en/12-taos-sql/16-operators.md index c426e28793..8dd1cef5ca 100644 --- a/docs/en/12-taos-sql/16-operators.md +++ b/docs/en/12-taos-sql/16-operators.md @@ -1,6 +1,7 @@ --- sidebar_label: Operators title: Operators +description: TDengine Supported Operators --- ## Arithmetic Operators diff --git a/docs/en/12-taos-sql/17-json.md b/docs/en/12-taos-sql/17-json.md index 77f7743033..1f08197dad 100644 --- a/docs/en/12-taos-sql/17-json.md +++ b/docs/en/12-taos-sql/17-json.md @@ -1,6 +1,7 @@ --- sidebar_label: JSON Type title: JSON Type +description: JSON Data Type --- diff --git a/docs/en/12-taos-sql/18-escape.md b/docs/en/12-taos-sql/18-escape.md index a2ae40de98..872397b29a 100644 --- a/docs/en/12-taos-sql/18-escape.md +++ b/docs/en/12-taos-sql/18-escape.md @@ -1,5 +1,6 @@ --- title: Escape Characters +description: How to use Escape --- ## Escape Characters diff --git a/docs/en/12-taos-sql/19-limit.md b/docs/en/12-taos-sql/19-limit.md index 0486ea3094..b63cf469b8 100644 --- a/docs/en/12-taos-sql/19-limit.md +++ b/docs/en/12-taos-sql/19-limit.md @@ -1,6 +1,7 @@ --- -sidebar_label: Name and Size Limits -title: Name and Size Limits +sidebar_label: Limits +title: Limits +description: Naming Limits --- ## Naming Rules diff --git a/docs/en/12-taos-sql/20-keywords.md b/docs/en/12-taos-sql/20-keywords.md index 6f166c8034..9d8d7c4767 100644 --- a/docs/en/12-taos-sql/20-keywords.md +++ b/docs/en/12-taos-sql/20-keywords.md @@ -1,6 +1,7 @@ --- -sidebar_label: Reserved Keywords +sidebar_label: Keywords title: Reserved Keywords +description: Reserved Keywords in TDengine SQL --- ## Keyword List diff --git a/docs/en/12-taos-sql/26-udf.md b/docs/en/12-taos-sql/26-udf.md index 03251067ad..71603c8804 100644 --- a/docs/en/12-taos-sql/26-udf.md +++ b/docs/en/12-taos-sql/26-udf.md @@ -1,6 +1,7 @@ --- -sidebar_label: User-Defined Functions +sidebar_label: UDF title: User-Defined Functions (UDF) +description: User Defined Functions --- You can create user-defined functions and import them into TDengine. diff --git a/docs/en/12-taos-sql/27-index.md b/docs/en/12-taos-sql/27-index.md index 7d09bc43ab..7215c26f6a 100644 --- a/docs/en/12-taos-sql/27-index.md +++ b/docs/en/12-taos-sql/27-index.md @@ -1,6 +1,7 @@ --- sidebar_label: Index title: Using Indices +description: Use Index to Accelerate Query. --- TDengine supports SMA and FULLTEXT indexing. diff --git a/docs/en/17-tools/03-taosbenchmark.md b/docs/en/17-tools/03-taosbenchmark.md index 07de52c734..2a10a395a4 100644 --- a/docs/en/17-tools/03-taosbenchmark.md +++ b/docs/en/17-tools/03-taosbenchmark.md @@ -1,6 +1,7 @@ --- title: taosBenchmark sidebar_label: taosBenchmark +description: Benchmark Tool for TDengine. --- ## Introduction diff --git a/docs/en/20-faq.md b/docs/en/20-faq.md deleted file mode 100644 index 32cce9075d..0000000000 --- a/docs/en/20-faq.md +++ /dev/null @@ -1 +0,0 @@ -# FAQ \ No newline at end of file -- GitLab