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.

Sign up for GitHub

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

readme, quickstart: reorganize the quick start structure #594

Merged
merged 6 commits into from
Sep 5, 2018
Merged

readme, quickstart: reorganize the quick start structure #594

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c58ced9
readme, quickstart: reorganize the quick start structure
QueenyJin Sep 5, 2018
d1917fd
QUICKSTART: add a link to try tidb
QueenyJin Sep 5, 2018
9537d06
trytidb: add more information
QueenyJin Sep 5, 2018
6dc7da4
Address comments
QueenyJin Sep 5, 2018
967ced8
Address comments
QueenyJin Sep 5, 2018
af07e8c
quickstart: add a blank line
lilin90 Sep 5, 2018
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
8 changes: 4 additions & 4 deletions QUICKSTART.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: TiDB Quick Start Guide
summary: Learn how to deploy a TiDB cluster quickly.
summary: Learn how to quickly start a TiDB cluster.
category: quick start
---

# TiDB Quick Start Guide

This guide introduces how to deploy and monitor a TiDB cluster on your local drive using Docker Compose for experimenting and testing.

**Warning:** Deploying TiDB using Docker Compose can only be used for experimental purposes. For production usage, [use Ansible to deploy the TiDB cluster](op-guide/ansible-deployment.md).
> **Warning:** Deploying TiDB using Docker Compose can only be used for experimental purposes. For production usage, [use Ansible to deploy the TiDB cluster](op-guide/ansible-deployment.md).

## Prerequisites

Expand Down Expand Up @@ -50,11 +50,11 @@ Congratulations! You have deployed a TiDB cluster! You can see messages in your

You can now test your TiDB server using one of the following methods:

- Use the MySQL client to connect to TiDB to read and write data:
- Use the MySQL client to connect to TiDB:

```
mysql -h 127.0.0.1 -P 4000 -u root
```

You can [try TiDB](try-tidb.md) to explore the SQL statements.
QueenyJin marked this conversation as resolved.
Show resolved Hide resolved
- Use Grafana to view the status of the cluster via [http://localhost:3000](http://localhost:3000) with the default account name and password: `admin` and `admin`.
- Use [TiDB-Vision](https://github.com/pingcap/tidb-vision), a cluster visualization tool, to see data transfer and load-balancing inside your cluster via [http://localhost:8010](http://localhost:8010).
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
+ About TiDB
- [TiDB Introduction](overview.md#tidb-introduction)
- [TiDB Architecture](overview.md#tidb-architecture)
- [TiDB Quick Start Guide](QUICKSTART.md)
+ Quick Start
- [TiDB Quick Start Guide](QUICKSTART.md)
- [Basic SQL statements](try-tidb.md)
Copy link
Member

Choose a reason for hiding this comment

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

statements -> Statements

- [TiDB Tutorial](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/)
+ TiDB User Guide
+ TiDB Server Administration
Expand Down
6 changes: 4 additions & 2 deletions try-tidb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
title: Try TiDB
summary: Some examples on how to test a TiDB cluster.
summary: Basic SQL statement for the TiDB database.
Copy link
Member

Choose a reason for hiding this comment

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

For the "summary", we have been using a sentence pattern starting with a verb. So to keep it consistent, it'd be better to update it to:

Learn about the basic SQL statements for the TiDB database.

category: try tidb
---

# Try TiDB

This guide demonstrates some basic CRUD operations of TiDB that you can perform in the terminal after you successfully deployed a TiDB cluster.
After you successfully deploy a TiDB cluster, you can run SQL statements in TiDB. Because TiDB is compatible with MySQL, you can use MySQL client to connect to TiDB and run MySQL statements directly in most of the cases. For more information, see [Compatibility with MySQL](sql/mysql-compatibility).
Copy link
Member

Choose a reason for hiding this comment

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

  • use MySQL client -> use the MySQL client
  • (sql/mysql-compatibility) -> (sql/mysql-compatibility.md)


This page includes some basic SQL statements such as CRUD operations. For a complete list of the statements, see [TiDB SQL Syntax Diagram](https://pingcap.github.io/sqlgram/).

## Create, show, and drop a database

Expand Down