From 5f7568c9785fcbb885b77dee8a803b8c250083d8 Mon Sep 17 00:00:00 2001 From: yikeke Date: Wed, 25 Jul 2018 13:37:20 +0800 Subject: [PATCH 1/4] op-guide: add summary metadata --- op-guide/ansible-deployment-rolling-update.md | 1 + op-guide/ansible-deployment-scale.md | 1 + op-guide/ansible-deployment.md | 1 + op-guide/ansible-operation.md | 1 + op-guide/backup-restore.md | 3 ++- op-guide/configuration.md | 1 + op-guide/dashboard-overview-info.md | 1 + op-guide/docker-compose.md | 2 +- op-guide/docker-deployment.md | 1 + op-guide/gc.md | 1 + op-guide/generate-self-signed-certificates.md | 1 + op-guide/history-read.md | 1 + 12 files changed, 13 insertions(+), 2 deletions(-) diff --git a/op-guide/ansible-deployment-rolling-update.md b/op-guide/ansible-deployment-rolling-update.md index 9bb531793b5ba..92ed9b70190e8 100644 --- 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 index d558443a0ecb1..f256512cbff8d 100644 --- 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 index b658fb254a922..d49d5996790e3 100644 --- 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 index dcccbb1993270..8ecc8af11380f 100644 --- 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 index cdb87a09d52db..1b83d94caeb71 100644 --- a/op-guide/backup-restore.md +++ b/op-guide/backup-restore.md @@ -1,5 +1,6 @@ --- title: Backup and Restore +summary: Learn how to backup and restore data of TiDB. category: operations --- @@ -7,7 +8,7 @@ category: operations ## 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 backup and restore 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 index a3dd451f5fb4f..c5d57f52c4c37 100644 --- 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 index 0aa752ec847c0..0d816f5c5149d 100644 --- 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 index bd0af2f9a665e..ab271f4c2fe4a 100644 --- 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 index 915d7aa3cb7fb..b9812b09a0d67 100644 --- 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 index 62eaa6b49e679..52f88faea6d71 100644 --- a/op-guide/gc.md +++ b/op-guide/gc.md @@ -1,5 +1,6 @@ --- title: TiDB Garbage Collection (GC) +summary: Use TiDB Garbage Collection (GC) to clear obsolete data. category: advanced --- diff --git a/op-guide/generate-self-signed-certificates.md b/op-guide/generate-self-signed-certificates.md index d6f662e626c54..f10fc612943c8 100644 --- 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 index d984392bc5341..b9b925f0648f8 100644 --- 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 --- From d453b266589aeb85f5824d515286cb4d985243a1 Mon Sep 17 00:00:00 2001 From: yikeke Date: Wed, 25 Jul 2018 15:17:34 +0800 Subject: [PATCH 2/4] op-guide: add summary metadata#2 --- op-guide/horizontal-scale.md | 1 + op-guide/location-awareness.md | 1 + op-guide/migration-overview.md | 1 + op-guide/migration.md | 1 + op-guide/monitor-overview.md | 1 + op-guide/monitor.md | 1 + op-guide/offline-ansible-deployment.md | 1 + op-guide/recommendation.md | 1 + op-guide/security.md | 1 + op-guide/tidb-config-file.md | 1 + op-guide/tidb-v2-upgrade-guide.md | 3 ++- op-guide/tune-tikv.md | 1 + 12 files changed, 13 insertions(+), 1 deletion(-) diff --git a/op-guide/horizontal-scale.md b/op-guide/horizontal-scale.md index 7d5f70c6ec55a..368d7c0658fba 100644 --- 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 index 2d59d524fe639..214154567be75 100644 --- 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 index 6ac961dca7f90..f8128cac8d698 100644 --- 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 index 7c6373f66884a..f2aab97f906c0 100644 --- 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 index 92028cf1b3d92..9f2aa98f2cec1 100644 --- 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 construct the TiDB monitoring framework. category: operations --- diff --git a/op-guide/monitor.md b/op-guide/monitor.md index 317850954d920..4f69558d3377c 100644 --- 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 index 79f2dd32e4211..e2c91cd3d8067 100644 --- 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 index a559e91866170..e63034b31282f 100644 --- 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 index 6650e86e1bf73..744c09e62c3b3 100644 --- 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 index 45964f8f24fd2..eadb42a3821ab 100644 --- 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 index 3aee15de9f406..b60c30985245e 100644 --- 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 index 6e3e21a05b87e..9214152eaf2ce 100644 --- 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 --- From bc2f28d622ccfa17c74a41bcbead94374add3c21 Mon Sep 17 00:00:00 2001 From: yikeke Date: Wed, 25 Jul 2018 16:30:53 +0800 Subject: [PATCH 3/4] tool: add summary metadata --- tools/loader.md | 1 + tools/pd-control.md | 1 + tools/syncer.md | 1 + tools/tidb-binlog-kafka.md | 1 + tools/tidb-binlog.md | 1 + tools/tidb-controller.md | 1 + tools/tikv-control.md | 1 + 7 files changed, 7 insertions(+) diff --git a/tools/loader.md b/tools/loader.md index 94e47c95a222a..a6ed18d416bdf 100644 --- a/tools/loader.md +++ b/tools/loader.md @@ -1,5 +1,6 @@ --- title: Loader Instructions +summary: Use Loader to load data to TiDB. category: advanced --- diff --git a/tools/pd-control.md b/tools/pd-control.md index 282271d941ba6..505699a79c065 100644 --- a/tools/pd-control.md +++ b/tools/pd-control.md @@ -1,5 +1,6 @@ --- title: PD Control User Guide +summary: Use PD Control to obtain the state information of a cluster and tune a cluster. category: tools --- diff --git a/tools/syncer.md b/tools/syncer.md index 43def6cf1a6c6..130cd0dfeee06 100644 --- a/tools/syncer.md +++ b/tools/syncer.md @@ -1,5 +1,6 @@ --- title: Syncer User Guide +summary: Use Syncer to import data incrementally to TiDB. category: advanced --- diff --git a/tools/tidb-binlog-kafka.md b/tools/tidb-binlog-kafka.md index 52db2317b2013..eafcd2aa12f63 100644 --- a/tools/tidb-binlog-kafka.md +++ b/tools/tidb-binlog-kafka.md @@ -1,5 +1,6 @@ --- title: TiDB-Binlog user guide +summary: Learn how to deploy the Kafka version of TiDB-Binlog. category: tool --- diff --git a/tools/tidb-binlog.md b/tools/tidb-binlog.md index fccf4b3db281a..4d9d5985fdd96 100644 --- a/tools/tidb-binlog.md +++ b/tools/tidb-binlog.md @@ -1,5 +1,6 @@ --- title: TiDB-Binlog user guide +summary: Learn how to install, deploy and monitor TiDB-Binlog. category: tool --- diff --git a/tools/tidb-controller.md b/tools/tidb-controller.md index c9b4c089cd23e..996d5d5b16ade 100644 --- a/tools/tidb-controller.md +++ b/tools/tidb-controller.md @@ -1,5 +1,6 @@ --- title: TiDB Controller User Guide +summary: Use TiDB Controller to obtain TiDB status information for debugging. category: tools --- diff --git a/tools/tikv-control.md b/tools/tikv-control.md index ea13d7cafb0aa..a4aeee071d74a 100644 --- a/tools/tikv-control.md +++ b/tools/tikv-control.md @@ -1,5 +1,6 @@ --- title: TiKV Control User Guide +summary: Use TiKV Control to manage a TiKV cluster. category: tools --- From 4cb23c11795c6265ba4d3c2532bd6e409e02eddc Mon Sep 17 00:00:00 2001 From: yikeke Date: Wed, 25 Jul 2018 17:29:20 +0800 Subject: [PATCH 4/4] op-guide: address comment --- op-guide/backup-restore.md | 4 ++-- op-guide/gc.md | 2 +- op-guide/monitor-overview.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/op-guide/backup-restore.md b/op-guide/backup-restore.md index 1b83d94caeb71..e95e57f58caee 100644 --- a/op-guide/backup-restore.md +++ b/op-guide/backup-restore.md @@ -1,6 +1,6 @@ --- title: Backup and Restore -summary: Learn how to backup and restore data of TiDB. +summary: Learn how to back up and restore the data of TiDB. category: operations --- @@ -8,7 +8,7 @@ category: operations ## About -This document describes how to backup and restore 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/gc.md b/op-guide/gc.md index 52f88faea6d71..477e3be58ff4a 100644 --- a/op-guide/gc.md +++ b/op-guide/gc.md @@ -1,6 +1,6 @@ --- title: TiDB Garbage Collection (GC) -summary: Use TiDB Garbage Collection (GC) to clear obsolete data. +summary: Use Garbage Collection (GC) to clear the obsolete data of TiDB. category: advanced --- diff --git a/op-guide/monitor-overview.md b/op-guide/monitor-overview.md index 9f2aa98f2cec1..b470b6e113c7a 100644 --- a/op-guide/monitor-overview.md +++ b/op-guide/monitor-overview.md @@ -1,6 +1,6 @@ --- title: Overview of the TiDB Monitoring Framework -summary: Use Prometheus and Grafana to construct the TiDB monitoring framework. +summary: Use Prometheus and Grafana to build the TiDB monitoring framework. category: operations ---