*: add summary metadata to 63 docs files (#549)

* *: add summary metadata to 63 docs files * tikv: update summary wording
pingcap · Jul 26, 2018 · 8c96693 · 8c96693
1 parent 021f2b1
commit 8c96693
Show file tree

Hide file tree

Showing 63 changed files with 91 additions and 15 deletions.
diff --git a/FAQ.md b/FAQ.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB FAQ
+summary: Learn about the most frequently asked questions (FAQs) relating to TiDB.
 category: faq
 ---
 

diff --git a/QUICKSTART.md b/QUICKSTART.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB Quick Start Guide
+summary: Learn how to deploy a TiDB cluster and try it quickly.
 category: quick start
 ---
 
@@ -21,7 +22,7 @@ The architecture is as follows:
 
 ![TiDB Architecture](media/tidb-architecture.png)
 
-For details of deploying a TiDB cluster, see [Ansible Deployment](op-guide/ansible-deployment.md).
+To quickly deploy a TiDB testing cluster, see [Deploy TiDB Using Docker Compose](op-guide/docker-compose.md).
 
 ## Try TiDB
 

diff --git a/ROADMAP.md b/ROADMAP.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB Roadmap
+summary: Learn about the roadmap of TiDB.
 category: Roadmap
 ---
 

diff --git a/adopters.md b/adopters.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB Adopters
+summary: Learn about the list of TiDB adopters in various industries.
 category: adopters
 ---
 

diff --git a/community.md b/community.md
@@ -1,5 +1,6 @@
 ---
 title: Connect with us
+summary: Learn about how to connect with us.
 category: community
 ---
 

diff --git a/overview.md b/overview.md
@@ -1,5 +1,6 @@
 ---
 title: About TiDB
+summary: Learn about what TiDB is, and the key features, architecture and roadmap of TiDB.
 category: introduction
 ---
 

diff --git a/sql/admin.md b/sql/admin.md
@@ -1,5 +1,6 @@
 ---
 title: Database Administration Statements
+summary: Use administration statements to manage the TiDB database. 
 category: user guide
 ---
 

diff --git a/sql/aggregate-group-by-functions.md b/sql/aggregate-group-by-functions.md
@@ -1,10 +1,13 @@
 ---
 title: Aggregate (GROUP BY) Functions
+summary: Learn about the supported aggregate functions in TiDB.
 category: user guide
 ---
 
 # Aggregate (GROUP BY) Functions
 
+This document describes details about the supported aggregate functions in TiDB.
+
 ## Aggregate (GROUP BY) function descriptions
 
 This section describes the supported MySQL group (aggregate) functions in TiDB.

diff --git a/sql/bit-functions-and-operators.md b/sql/bit-functions-and-operators.md
@@ -1,5 +1,6 @@
 ---
 title: Bit Functions and Operators
+summary: Learn about the bit functions and operators.
 category: user guide
 ---
 

diff --git a/sql/cast-functions-and-operators.md b/sql/cast-functions-and-operators.md
@@ -1,5 +1,6 @@
 ---
 title: Cast Functions and Operators
+summary: Learn about the cast functions and operators.
 category: user guide
 ---
 

diff --git a/sql/character-set-configuration.md b/sql/character-set-configuration.md
@@ -1,5 +1,6 @@
 ---
 title: Character Set Configuration
+summary: Learn about the character set configuration.
 category: user guide
 ---
 

diff --git a/sql/character-set-support.md b/sql/character-set-support.md
@@ -1,5 +1,6 @@
 ---
 title: Character Set Support
+summary: Learn about the supported character sets in TiDB.
 category: user guide
 ---
 

diff --git a/sql/comment-syntax.md b/sql/comment-syntax.md
@@ -1,5 +1,6 @@
 ---
 title: Comment Syntax
+summary: Learn about the three comment styles in TiDB.
 category: user guide
 ---
 

diff --git a/sql/connection-and-APIs.md b/sql/connection-and-APIs.md
@@ -1,5 +1,6 @@
 ---
-title: Connectors and APIs
+title: Connectors and APIs 
+summary: Learn about the connectors and APIs.
 category: user guide
 ---
 

diff --git a/sql/control-flow-functions.md b/sql/control-flow-functions.md
@@ -1,5 +1,6 @@
 ---
 title: Control Flow Functions
+summary: Learn about the Control Flow functions.
 category: user guide
 ---
 

diff --git a/sql/datatype.md b/sql/datatype.md
@@ -1,12 +1,11 @@
 ---
 title: TiDB Data Type
+summary: Learn about the data types supported in TiDB.
 category: user guide
 ---
 
 # TiDB Data Type
 
-## Overview
-
 TiDB supports all the data types in MySQL except the Spatial type, including numeric type, string type, date & time type, and JSON type.
 
 The definition of the data type is: `T(M[, D])`. In this format:

diff --git a/sql/date-and-time-functions.md b/sql/date-and-time-functions.md
@@ -1,5 +1,6 @@
 ---
 title: Date and Time Functions
+summary: Learn how to use the data and time functions.
 category: user guide
 ---
 

diff --git a/sql/ddl.md b/sql/ddl.md
@@ -1,5 +1,6 @@
 ---
 title: Data Definition Statements
+summary: Learn how to use DDL (Data Definition Language) in TiDB.
 category: user guide
 ---
 

diff --git a/sql/dml.md b/sql/dml.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB Data Manipulation Language
+summary: Use DML (Data Manipulation Language) to select, insert, delete and update the data.
 category: user guide
 ---
 

diff --git a/sql/encrypted-connections.md b/sql/encrypted-connections.md
@@ -1,5 +1,6 @@
 ---
 title: Use Encrypted Connections
+summary: Use the encrypted connection to ensure data security.
 category: user guide
 ---
 

diff --git a/sql/encryption-and-compression-functions.md b/sql/encryption-and-compression-functions.md
@@ -1,5 +1,6 @@
 ---
 title: Encryption and Compression Functions
+summary: Learn about the encryption and compression functions.
 category: user guide
 ---
 

diff --git a/sql/error.md b/sql/error.md
@@ -1,5 +1,6 @@
 ---
 title: Error Codes and Troubleshooting
+summary: Learn about the error codes and solutions in TiDB.
 category: user guide
 ---
 

diff --git a/sql/expression-syntax.md b/sql/expression-syntax.md
@@ -1,5 +1,6 @@
 ---
 title: Expression Syntax
+summary: Learn about the expression syntax in TiDB.
 category: user guide
 ---
 

diff --git a/sql/functions-and-operators-reference.md b/sql/functions-and-operators-reference.md
@@ -1,5 +1,6 @@
 ---
 title: Function and Operator Reference
+summary: Learn how to use the functions and operators.
 category: user guide
 ---
 

diff --git a/sql/information-functions.md b/sql/information-functions.md
@@ -1,5 +1,6 @@
 ---
 title: Information Functions
+summary: Learn about the information functions.
 category: user guide
 ---
 

diff --git a/sql/json-functions-generated-column.md b/sql/json-functions-generated-column.md
@@ -1,5 +1,6 @@
 ---
 title: JSON Functions and Generated Column
+summary: Learn how to use JSON functions and generated column to handle scenarios with uncertain schema.
 category: user guide
 ---
 

diff --git a/sql/json-functions.md b/sql/json-functions.md
@@ -1,5 +1,6 @@
 ---
 title: JSON Functions
+summary: Learn about JSON functions.
 category: user guide
 ---
 

diff --git a/sql/keywords-and-reserved-words.md b/sql/keywords-and-reserved-words.md
@@ -1,5 +1,6 @@
 ---
 title: Keywords and Reserved Words
+summary: Learn about the keywords and reserved words in TiDB.
 category: user guide
 ---
 

diff --git a/sql/literal-values.md b/sql/literal-values.md
@@ -1,10 +1,13 @@
 ---
 title: Literal Values
+summary: Learn how to use various literal values.
 category: user guide
 ---
 
 # Literal Values
 
+This document describes String literals, Numeric literals, NULL values, Hexadecimal literals, Date and time literals, Boolean literals, and Bit-value literals.
+
 ## String literals
 
 A string is a sequence of bytes or characters, enclosed within either single quote `'` or double quote `"` characters. For example:

diff --git a/sql/miscellaneous-functions.md b/sql/miscellaneous-functions.md
@@ -1,5 +1,6 @@
 ---
 title: Miscellaneous Functions
+summary: Learn about miscellaneous functions in TiDB.
 category: user guide
 ---
 

diff --git a/sql/mysql-compatibility.md b/sql/mysql-compatibility.md
@@ -1,5 +1,6 @@
 ---
 title: Compatibility with MySQL
+summary: Learn about the compatibility of TiDB with MySQL, and the unsupported and different features.
 category: user guide
 ---
 

diff --git a/sql/numeric-functions-and-operators.md b/sql/numeric-functions-and-operators.md
@@ -1,10 +1,13 @@
 ---
 title: Numeric Functions and Operators
+summary: Learn about the numeric functions and operators.
 category: user guide
 ---
 
 # Numeric Functions and Operators
 
+This document describes the arithmetic operators and mathematical functions.
+
 ## Arithmetic operators
 
 | Name                                                                                        | Description                       |

diff --git a/sql/operators.md b/sql/operators.md
@@ -1,5 +1,13 @@
+---
+title: Operators
+summary: Learn about the operators precedence, comparison functions and operators, logical operators, and assignment operators.
+category: user guide
+---
+
 # Operators
 
+This document describes the operators precedence, comparison functions and operators, logical operators, and assignment operators.
+
 - [Operator precedence](#operator-precedence)
 - [Comparison functions and operators](#comparison-functions-and-operators)
 - [Logical operators](#logical-operators)

diff --git a/sql/precision-math.md b/sql/precision-math.md
@@ -1,5 +1,6 @@
 ---
 title: Precision Math
+summary: Learn about the precision math in TiDB.
 category: user guide
 ---
 

diff --git a/sql/prepare.md b/sql/prepare.md
@@ -1,5 +1,6 @@
 ---
 title: Prepared SQL Statement Syntax
+summary: Use Prepared statements to reduce the load of statement parsing and query optimization, and improve execution efficiency.
 category: user guide
 ---
 

diff --git a/sql/privilege.md b/sql/privilege.md
@@ -1,12 +1,11 @@
 ---
 title: Privilege Management
+summary: Learn how to manage the privilege.
 category: user guide
 ---
 
 # Privilege Management
 
-## Privilege management overview
-
 TiDB's privilege management system is implemented according to the privilege management system in MySQL. It supports most of the syntaxes and privilege types in MySQL. If you find any inconsistency with MySQL, feel free to [open an issue](https://github.com/pingcap/docs-cn/issues/new).
 
 ## Examples

diff --git a/sql/schema-object-names.md b/sql/schema-object-names.md
@@ -1,5 +1,6 @@
 ---
 title: Schema Object Names
+summary: Learn about the schema object names (identifiers) in TiDB.
 category: user guide
 ---
 

diff --git a/sql/server-command-option.md b/sql/server-command-option.md
@@ -1,10 +1,13 @@
 ---
 title: The TiDB Command Options
+summary: Learn about TiDB command options and configuration files.
 category: user guide
 ---
 
 # The TiDB Command Options
 
+This document describes the startup options and TiDB server configuration files.
+
 ## TiDB startup options
 
 When you start TiDB processes, you can specify some program options.

diff --git a/sql/statistics.md b/sql/statistics.md
@@ -1,5 +1,6 @@
 ---
 title: Introduction to Statistics
+summary: Learn how the statistics collect table-level and column-level information.
 category: user guide
 ---
 

diff --git a/sql/string-functions.md b/sql/string-functions.md
@@ -1,9 +1,9 @@
 ---
 title: String Functions
+summary: Learn about the string functions in TiDB.
 category: user guide
 ---
 
-
 # String Functions
 
 | Name                                                                                                              | Description                                                                                                                               |

diff --git a/sql/system-database.md b/sql/system-database.md
@@ -1,5 +1,6 @@
 ---
 title: The TiDB System Database
+summary: Learn tables contained in the TiDB System Database.
 category: user guide
 ---
 

diff --git a/sql/tidb-memory-control.md b/sql/tidb-memory-control.md
@@ -1,11 +1,12 @@
 ---
 title: TiDB Memory Control
+summary: Learn how to configure the memory quota of a query and avoid OOM (out of memory).
 category: user guide
 ---
 
 # TiDB Memory Control
 
-Currently TiDB can track the memory quota of a single SQL query and take actions to prevent OOM (out of memory) or troubleshoot OOM when the memory usage exceeds a specific threshold value. In the TiDB configuration file, you can configure the options as below to control TiDB behaviors when the memory quota exceeds the threshold value:
+Currently, TiDB can track the memory quota of a single SQL query and take actions to prevent OOM (out of memory) or troubleshoot OOM when the memory usage exceeds a specific threshold value. In the TiDB configuration file, you can configure the options as below to control TiDB behaviors when the memory quota exceeds the threshold value:
 
 ```
 # Valid options: ["log", "cancel"]

diff --git a/sql/tidb-server.md b/sql/tidb-server.md
@@ -1,12 +1,11 @@
 ---
 title: The TiDB Server
+summary: Learn about the basic management functions of the TiDB cluster.
 category: user guide
 ---
 
 # The TiDB Server
 
-## TiDB service
-
 TiDB refers to the TiDB database management system. This document describes the basic management functions of the TiDB cluster.
 
 ## TiDB cluster startup configuration

diff --git a/sql/tidb-specific.md b/sql/tidb-specific.md
@@ -1,5 +1,6 @@
 ---
 title: The Proprietary System Variables and Syntaxes in TiDB
+summary: Use the proprietary system variables and syntaxes in TiDB to optimize performance.
 category: user guide
 ---
 

diff --git a/sql/time-zone.md b/sql/time-zone.md
@@ -1,5 +1,6 @@
 ---
 title: Time Zone
+summary: Learn how to set the time zone and its format.
 category: user guide
 ---
 
@@ -12,6 +13,7 @@ You can use the following statement to set the global server `time_zone` value a
 ```sql
 mysql> SET GLOBAL time_zone = timezone;
 ```
+
 Each client has its own time zone setting, given by the session `time_zone` variable. Initially, the session variable takes its value from the global `time_zone` variable, but the client can change its own time zone with this statement:
 
 ```sql