Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Jul 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TiDB FAQ
summary: Learn about the most frequently asked questions (FAQs) relating to TiDB.
category: faq
---

Expand Down
3 changes: 2 additions & 1 deletion QUICKSTART.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TiDB Quick Start Guide
summary: Learn how to deploy a TiDB cluster and try it quickly.
category: quick start
---

Expand All @@ -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

Expand Down
1 change: 1 addition & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TiDB Roadmap
summary: Learn about the roadmap of TiDB.
category: Roadmap
---

Expand Down
1 change: 1 addition & 0 deletions adopters.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TiDB Adopters
summary: Learn about the list of TiDB adopters in various industries.
category: adopters
---

Expand Down
1 change: 1 addition & 0 deletions community.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Connect with us
summary: Learn about how to connect with us.
category: community
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/ansible-deployment-rolling-update.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/ansible-deployment-scale.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/ansible-deployment.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Deploy TiDB Using Ansible
summary: Use Ansible to deploy a TiDB cluster.
category: operations
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/ansible-operation.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
3 changes: 2 additions & 1 deletion op-guide/backup-restore.md
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
1 change: 1 addition & 0 deletions op-guide/configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Configuration Flags
summary: Learn some configuration flags of TiDB, TiKV and PD.
category: operations
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/dashboard-overview-info.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Key Metrics
summary: Learn some key metrics displayed on the Grafana Overview dashboard.
category: operations
---

Expand Down
2 changes: 1 addition & 1 deletion op-guide/docker-compose.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/docker-deployment.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/gc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TiDB Garbage Collection (GC)
summary: Use Garbage Collection (GC) to clear the obsolete data of TiDB.
category: advanced
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/generate-self-signed-certificates.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Generate Self-signed Certificates
summary: Use `cfssl` to generate self-signed certificates.
category: deployment
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/history-read.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Reading Data from History Versions
summary: Learn about how TiDB reads data from history versions.
category: advanced
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/horizontal-scale.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Scale a TiDB cluster
summary: Learn how to add or delete PD, TiKV and TiDB nodes.
category: operations
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/location-awareness.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Cross-Region Deployment
summary: Learn the cross-region deployment that maximizes the capacity for disaster recovery.
category: operations
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/migration-overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Migration Overview
summary: Learn how to migrate data from MySQL to TiDB.
category: operations
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/migration.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/monitor-overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Overview of the TiDB Monitoring Framework
summary: Use Prometheus and Grafana to build the TiDB monitoring framework.
category: operations
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/monitor.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Monitor a TiDB Cluster
summary: Learn how to monitor the state of a TiDB cluster.
category: operations
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/offline-ansible-deployment.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Deploy TiDB Offline Using Ansible
summary: Use Ansible to deploy a TiDB cluster offline.
category: operations
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/recommendation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Software and Hardware Requirements
summary: Learn the software and hardware requirements for deploying and running TiDB.
category: operations
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/security.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Enable TLS Authentication
summary: Learn how to enable TLS authentication in a TiDB cluster.
category: deployment
---

Expand Down
1 change: 1 addition & 0 deletions op-guide/tidb-config-file.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
3 changes: 2 additions & 1 deletion op-guide/tidb-v2-upgrade-guide.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
1 change: 1 addition & 0 deletions op-guide/tune-tikv.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Tune TiKV Performance
summary: Learn how to tune the TiKV parameters for optimal performance.
category: tuning
---

Expand Down
1 change: 1 addition & 0 deletions overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: About TiDB
summary: Learn about what TiDB is, and the key features, architecture and roadmap of TiDB.
category: introduction
---

Expand Down
1 change: 1 addition & 0 deletions sql/admin.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Database Administration Statements
summary: Use administration statements to manage the TiDB database.
category: user guide
---

Expand Down
3 changes: 3 additions & 0 deletions sql/aggregate-group-by-functions.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions sql/bit-functions-and-operators.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Bit Functions and Operators
summary: Learn about the bit functions and operators.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/cast-functions-and-operators.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Cast Functions and Operators
summary: Learn about the cast functions and operators.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/character-set-configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Character Set Configuration
summary: Learn about the character set configuration.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/character-set-support.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Character Set Support
summary: Learn about the supported character sets in TiDB.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/comment-syntax.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Comment Syntax
summary: Learn about the three comment styles in TiDB.
category: user guide
---

Expand Down
3 changes: 2 additions & 1 deletion sql/connection-and-APIs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Connectors and APIs
title: Connectors and APIs
summary: Learn about the connectors and APIs.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/control-flow-functions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Control Flow Functions
summary: Learn about the Control Flow functions.
category: user guide
---

Expand Down
3 changes: 1 addition & 2 deletions sql/datatype.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
1 change: 1 addition & 0 deletions sql/date-and-time-functions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Date and Time Functions
summary: Learn how to use the data and time functions.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/ddl.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Data Definition Statements
summary: Learn how to use DDL (Data Definition Language) in TiDB.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/dml.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
1 change: 1 addition & 0 deletions sql/encrypted-connections.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Use Encrypted Connections
summary: Use the encrypted connection to ensure data security.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/encryption-and-compression-functions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Encryption and Compression Functions
summary: Learn about the encryption and compression functions.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/error.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Error Codes and Troubleshooting
summary: Learn about the error codes and solutions in TiDB.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/expression-syntax.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Expression Syntax
summary: Learn about the expression syntax in TiDB.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/functions-and-operators-reference.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Function and Operator Reference
summary: Learn how to use the functions and operators.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/information-functions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Information Functions
summary: Learn about the information functions.
category: user guide
---

Expand Down
1 change: 1 addition & 0 deletions sql/json-functions-generated-column.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
1 change: 1 addition & 0 deletions sql/json-functions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: JSON Functions
summary: Learn about JSON functions.
category: user guide
---

Expand Down
Loading