*: add summary metadata to all docs files for SEO (pingcap#550)

* op-guide, tool: add summary metadata (pingcap#548) * op-guide: add summary metadata * op-guide: add summary metadata#2 * tool: add summary metadata * op-guide: address comment * *: add summary metadata to 63 docs files (pingcap#549) * *: add summary metadata to 63 docs files * tikv: update summary wording
Liuxiaozhen12 · Jul 26, 2018 · c1e613d · c1e613d
1 parent 240119a
commit c1e613d
Show file tree

Hide file tree

Showing 94 changed files with 124 additions and 18 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/op-guide/ansible-deployment-rolling-update.md b/op-guide/ansible-deployment-rolling-update.md
@@ -1,5 +1,6 @@
 ---
 title: Upgrade TiDB Using TiDB-Ansible
+summary: Use TiDB-Ansible to perform a rolling update for a TiDB cluster.
 category: operations
 ---
 

diff --git a/op-guide/ansible-deployment-scale.md b/op-guide/ansible-deployment-scale.md
@@ -1,5 +1,6 @@
 ---
 title: Scale the TiDB Cluster Using TiDB-Ansible
+summary: Use TiDB-Ansible to increase/decrease the capacity of a TiDB/TiKV/PD node.
 category: operations
 ---
 

diff --git a/op-guide/ansible-deployment.md b/op-guide/ansible-deployment.md
@@ -1,5 +1,6 @@
 ---
 title: Deploy TiDB Using Ansible
+summary: Use Ansible to deploy a TiDB cluster.
 category: operations
 ---
 

diff --git a/op-guide/ansible-operation.md b/op-guide/ansible-operation.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB-Ansible Common Operations
+summary: Learn some common operations when using TiDB-Ansible to administer a TiDB cluster.
 category: operations
 ---
 

diff --git a/op-guide/backup-restore.md b/op-guide/backup-restore.md
@@ -1,13 +1,14 @@
 ---
 title: Backup and Restore
+summary: Learn how to back up and restore the data of TiDB.
 category: operations
 ---
 
 # Backup and Restore
 
 ## About
 
-This document describes how to backup and restore the data of TiDB. Currently, this document only covers full backup and restoration.
+This document describes how to back up and restore the data of TiDB. Currently, this document only covers full backup and restoration.
 
 Here we assume that the TiDB service information is as follows:
 

diff --git a/op-guide/configuration.md b/op-guide/configuration.md
@@ -1,5 +1,6 @@
 ---
 title: Configuration Flags
+summary: Learn some configuration flags of TiDB, TiKV and PD.
 category: operations
 ---
 

diff --git a/op-guide/dashboard-overview-info.md b/op-guide/dashboard-overview-info.md
@@ -1,5 +1,6 @@
 ---
 title: Key Metrics
+summary: Learn some key metrics displayed on the Grafana Overview dashboard.
 category: operations
 ---
 

diff --git a/op-guide/docker-compose.md b/op-guide/docker-compose.md
@@ -1,6 +1,6 @@
 ---
 title: TiDB Docker Compose Deployment
-summary: Deploy a TiDB testing cluster with a single command using Docker Compose.
+summary: Use Docker Compose to quickly deploy a TiDB testing cluster.
 category: operations
 ---
 

diff --git a/op-guide/docker-deployment.md b/op-guide/docker-deployment.md
@@ -1,5 +1,6 @@
 ---
 title: Deploy TiDB Using Docker
+summary: Use Docker to manually deploy a multi-node TiDB cluster on multiple machines.
 category: operations
 ---
 

diff --git a/op-guide/gc.md b/op-guide/gc.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB Garbage Collection (GC)
+summary: Use Garbage Collection (GC) to clear the obsolete data of TiDB.
 category: advanced
 ---
 

diff --git a/op-guide/generate-self-signed-certificates.md b/op-guide/generate-self-signed-certificates.md
@@ -1,5 +1,6 @@
 ---
 title: Generate Self-signed Certificates
+summary: Use `cfssl` to generate self-signed certificates.
 category: deployment
 ---
 

diff --git a/op-guide/history-read.md b/op-guide/history-read.md
@@ -1,5 +1,6 @@
 ---
 title: Reading Data from History Versions
+summary: Learn about how TiDB reads data from history versions.
 category: advanced
 ---
 

diff --git a/op-guide/horizontal-scale.md b/op-guide/horizontal-scale.md
@@ -1,5 +1,6 @@
 ---
 title: Scale a TiDB cluster
+summary: Learn how to add or delete PD, TiKV and TiDB nodes.
 category: operations
 ---
 

diff --git a/op-guide/location-awareness.md b/op-guide/location-awareness.md
@@ -1,5 +1,6 @@
 ---
 title: Cross-Region Deployment
+summary: Learn the cross-region deployment that maximizes the capacity for disaster recovery.
 category: operations
 ---
 

diff --git a/op-guide/migration-overview.md b/op-guide/migration-overview.md
@@ -1,5 +1,6 @@
 ---
 title: Migration Overview
+summary: Learn how to migrate data from MySQL to TiDB.
 category: operations
 ---
 

diff --git a/op-guide/migration.md b/op-guide/migration.md
@@ -1,5 +1,6 @@
 ---
 title: Migrate Data from MySQL to TiDB
+summary: Use `mydumper`, `loader` and `syncer` tools to migrate data from MySQL to TiDB.
 category: operations
 ---
 

diff --git a/op-guide/monitor-overview.md b/op-guide/monitor-overview.md
@@ -1,5 +1,6 @@
 ---
 title: Overview of the TiDB Monitoring Framework
+summary: Use Prometheus and Grafana to build the TiDB monitoring framework.
 category: operations
 ---
 

diff --git a/op-guide/monitor.md b/op-guide/monitor.md
@@ -1,5 +1,6 @@
 ---
 title: Monitor a TiDB Cluster
+summary: Learn how to monitor the state of a TiDB cluster.
 category: operations
 ---
 

diff --git a/op-guide/offline-ansible-deployment.md b/op-guide/offline-ansible-deployment.md
@@ -1,5 +1,6 @@
 ---
 title: Deploy TiDB Offline Using Ansible
+summary: Use Ansible to deploy a TiDB cluster offline.
 category: operations
 ---
 

diff --git a/op-guide/recommendation.md b/op-guide/recommendation.md
@@ -1,5 +1,6 @@
 ---
 title: Software and Hardware Requirements
+summary: Learn the software and hardware requirements for deploying and running TiDB.
 category: operations
 ---
 

diff --git a/op-guide/security.md b/op-guide/security.md
@@ -1,5 +1,6 @@
 ---
 title: Enable TLS Authentication
+summary: Learn how to enable TLS authentication in a TiDB cluster.
 category: deployment
 ---
 

diff --git a/op-guide/tidb-config-file.md b/op-guide/tidb-config-file.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB Configuration File Description
+summary: Learn the TiDB configuration file options that are not involved in command line options.
 category: deployment
 ---
 

diff --git a/op-guide/tidb-v2-upgrade-guide.md b/op-guide/tidb-v2-upgrade-guide.md
@@ -1,11 +1,12 @@
 ---
 title: TiDB 2.0 Upgrade Guide
+summary: Learn how to upgrade from TiDB 1.0/TiDB 2.0 RC version to TiDB 2.0 GA version.
 category: deployment
 ---
 
 # TiDB 2.0 Upgrade Guide
 
-This document describes how to upgrade from TiDB 1.0 or TiDB 2.0 RC versions to TiDB 2.0 GA.
+This document describes how to upgrade from TiDB 1.0 or TiDB 2.0 RC version to TiDB 2.0 GA version.
 
 ## Install Ansible and dependencies in the Control Machine
 

diff --git a/op-guide/tune-tikv.md b/op-guide/tune-tikv.md
@@ -1,5 +1,6 @@
 ---
 title: Tune TiKV Performance
+summary: Learn how to tune the TiKV parameters for optimal performance.
 category: tuning
 ---
 

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
 ---