From 524283386c30fa64509f14902a0a32a088a289b3 Mon Sep 17 00:00:00 2001 From: gccgdb1234 Date: Mon, 29 Aug 2022 16:26:11 +0800 Subject: [PATCH] doc: add description field --- docs/en/15-programming/01-connect/01-python.md | 2 +- docs/en/15-programming/01-connect/02-java.md | 2 +- docs/en/15-programming/01-connect/03-go.md | 2 +- docs/en/15-programming/01-connect/04-rust.md | 2 +- docs/en/15-programming/01-connect/05-node.md | 2 +- docs/en/15-programming/01-connect/09-rest-api.md | 2 +- docs/en/15-programming/03-connector/01-python.md | 1 + docs/en/15-programming/03-connector/02-java.md | 1 + docs/en/15-programming/03-connector/03-go.md | 1 + docs/en/15-programming/03-connector/04-rust.md | 1 + docs/en/15-programming/03-connector/05-node.md | 5 +++-- docs/en/15-programming/03-connector/09-rest-api.md | 1 + 12 files changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/en/15-programming/01-connect/01-python.md b/docs/en/15-programming/01-connect/01-python.md index 3704fc8883..3ab42ce7b7 100644 --- a/docs/en/15-programming/01-connect/01-python.md +++ b/docs/en/15-programming/01-connect/01-python.md @@ -1,7 +1,7 @@ --- sidebar_label: Python title: Connect with Python Connector -description: Python Connector for TDengine. +description: Connect to TDengine cloud service using Python connector --- import Tabs from '@theme/Tabs'; diff --git a/docs/en/15-programming/01-connect/02-java.md b/docs/en/15-programming/01-connect/02-java.md index 87a91e7b14..fd86538d41 100644 --- a/docs/en/15-programming/01-connect/02-java.md +++ b/docs/en/15-programming/01-connect/02-java.md @@ -1,7 +1,7 @@ --- sidebar_label: Java title: Connect with Java Connector -description: Java Connector for TDengine. +description: Connect to TDengine cloud service using Java connector --- import Tabs from '@theme/Tabs'; diff --git a/docs/en/15-programming/01-connect/03-go.md b/docs/en/15-programming/01-connect/03-go.md index 267e0e99ac..a513de7ff3 100644 --- a/docs/en/15-programming/01-connect/03-go.md +++ b/docs/en/15-programming/01-connect/03-go.md @@ -1,7 +1,7 @@ --- sidebar_label: Go title: Connect with Go Connector -description: Go Connector for TDengine. +description: Connect to TDengine cloud service using Go connector --- import Tabs from '@theme/Tabs'; diff --git a/docs/en/15-programming/01-connect/04-rust.md b/docs/en/15-programming/01-connect/04-rust.md index ad20066941..4161c62578 100644 --- a/docs/en/15-programming/01-connect/04-rust.md +++ b/docs/en/15-programming/01-connect/04-rust.md @@ -1,7 +1,7 @@ --- sidebar_label: Rust title: Connect with Rust Connector -description: Rust Connector for TDengine +description: Connect to TDengine cloud service using Rust connector --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/en/15-programming/01-connect/05-node.md b/docs/en/15-programming/01-connect/05-node.md index d88e4ec855..1ed900f979 100644 --- a/docs/en/15-programming/01-connect/05-node.md +++ b/docs/en/15-programming/01-connect/05-node.md @@ -1,7 +1,7 @@ --- sidebar_label: Node.js title: Connect with Node.js Connector -description: Node.JS Connector for TDengine +description: Connect to TDengine cloud service using Node.JS connector --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/en/15-programming/01-connect/09-rest-api.md b/docs/en/15-programming/01-connect/09-rest-api.md index 68e6c8fadb..948ce35c81 100644 --- a/docs/en/15-programming/01-connect/09-rest-api.md +++ b/docs/en/15-programming/01-connect/09-rest-api.md @@ -1,7 +1,7 @@ --- sidebar_label: REST API title: REST API -description: Communicate with TDengine Cloud Service through RESTful API +description: Connect to TDengine Cloud Service through RESTful API --- import Tabs from '@theme/Tabs'; diff --git a/docs/en/15-programming/03-connector/01-python.md b/docs/en/15-programming/03-connector/01-python.md index b26bf06187..fe782ccbed 100644 --- a/docs/en/15-programming/03-connector/01-python.md +++ b/docs/en/15-programming/03-connector/01-python.md @@ -1,6 +1,7 @@ --- sidebar_label: Python title: TDengine Python Connector +description: Detailed guide for Python Connector --- `taospy` is the official Python connector for TDengine. `taospy` wraps the [REST interface](/reference/rest-api) of TDengine. Additionally `taospy` provides a set of programming interfaces that conforms to the [Python Data Access Specification (PEP 249)](https://peps.python.org/pep-0249/). It is easy to integrate `taospy` with many third-party tools, such as [SQLAlchemy](https://www.sqlalchemy.org/) and [pandas](https://pandas.pydata.org/). diff --git a/docs/en/15-programming/03-connector/02-java.md b/docs/en/15-programming/03-connector/02-java.md index 788285cb09..d16b21621b 100644 --- a/docs/en/15-programming/03-connector/02-java.md +++ b/docs/en/15-programming/03-connector/02-java.md @@ -3,6 +3,7 @@ toc_max_heading_level: 4 sidebar_position: 2 sidebar_label: Java title: TDengine Java Connector +description: Detailed guide for Java Connector --- import Tabs from '@theme/Tabs'; diff --git a/docs/en/15-programming/03-connector/03-go.md b/docs/en/15-programming/03-connector/03-go.md index 62a0486f1a..9de2b31412 100644 --- a/docs/en/15-programming/03-connector/03-go.md +++ b/docs/en/15-programming/03-connector/03-go.md @@ -1,6 +1,7 @@ --- sidebar_label: Go title: TDengine Go Connector +description: Detailed guide for Python Connector --- `driver-go` is the official Go language connector for TDengine. It implements the [database/sql](https://golang.org/pkg/database/sql/) package, the generic Go language interface to SQL databases. Go developers can use it to develop applications that access TDengine cluster data. diff --git a/docs/en/15-programming/03-connector/04-rust.md b/docs/en/15-programming/03-connector/04-rust.md index 8aead88139..99765329f4 100644 --- a/docs/en/15-programming/03-connector/04-rust.md +++ b/docs/en/15-programming/03-connector/04-rust.md @@ -3,6 +3,7 @@ toc_max_heading_level: 4 sidebar_position: 5 sidebar_label: Rust title: TDengine Rust Connector +description: Detailed guide for Rust Connector --- diff --git a/docs/en/15-programming/03-connector/05-node.md b/docs/en/15-programming/03-connector/05-node.md index 91ab64136c..096d65c255 100644 --- a/docs/en/15-programming/03-connector/05-node.md +++ b/docs/en/15-programming/03-connector/05-node.md @@ -1,6 +1,7 @@ --- -sidebar_label: Node.js -title: TDengine Node.js Connector +sidebar_label: Node.JS +title: TDengine Node.JS Connector +description: Detailed guide for Node.JS Connector --- `td2.0-rest-connector` are the official Node.js language connectors for TDengine. Node.js developers can develop applications to access TDengine instance data. `td2.0-rest-connector` is a **REST connector** that connects to TDengine instances via the REST API. diff --git a/docs/en/15-programming/03-connector/09-rest-api.md b/docs/en/15-programming/03-connector/09-rest-api.md index 3904c957bb..b51d25843c 100644 --- a/docs/en/15-programming/03-connector/09-rest-api.md +++ b/docs/en/15-programming/03-connector/09-rest-api.md @@ -1,6 +1,7 @@ --- sidebar_label: REST API title: REST API +description: Detailed guide for REST API --- To support the development of various types of applications and platforms, TDengine provides an API that conforms to REST principles; namely REST API. To minimize the learning cost, unlike REST APIs for other database engines, TDengine allows insertion of SQL commands in the BODY of an HTTP POST request, to operate the database. -- GitLab