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

op-guide, tool: add summary metadata #548

Merged
merged 5 commits into from
Jul 25, 2018
Merged
Show file tree
Hide file tree
Changes from 4 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 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 backup and restore data of TiDB.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

data -> the data

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 backup and restore data of TiDB. Currently, this document only covers full backup and restoration.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

backup -> back up


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 TiDB Garbage Collection (GC) to clear obsolete data.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-> 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 construct the TiDB monitoring framework.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

construct -> build (more frequently used)

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 tools/loader.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Loader Instructions
summary: Use Loader to load data to TiDB.
category: advanced
---

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

Expand Down
1 change: 1 addition & 0 deletions tools/syncer.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Syncer User Guide
summary: Use Syncer to import data incrementally to TiDB.
category: advanced
---

Expand Down
1 change: 1 addition & 0 deletions tools/tidb-binlog-kafka.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TiDB-Binlog user guide
summary: Learn how to deploy the Kafka version of TiDB-Binlog.
category: tool
---

Expand Down
1 change: 1 addition & 0 deletions tools/tidb-binlog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TiDB-Binlog user guide
summary: Learn how to install, deploy and monitor TiDB-Binlog.
category: tool
---

Expand Down
1 change: 1 addition & 0 deletions tools/tidb-controller.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TiDB Controller User Guide
summary: Use TiDB Controller to obtain TiDB status information for debugging.
category: tools
---

Expand Down
1 change: 1 addition & 0 deletions tools/tikv-control.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TiKV Control User Guide
summary: Use TiKV Control to manage a TiKV cluster.
category: tools
---

Expand Down