Skip to content
Permalink
Browse files

*: reorganize content to display version switcher (#1250)

* *: reorganize content to display version switcher

Via: pingcap/docs-cn#1496

* scripts: add v2.1
  • Loading branch information...
lilin90 authored and YiniXu9506 committed Jun 24, 2019
1 parent 1b8085d commit df2a250b463079a35143ef913198732d4c6be5dd
Showing 1,215 changed files with 132,475 additions and 1,579 deletions.
385 TOC.md

This file was deleted.

@@ -0,0 +1,38 @@
---
title: TiDB Introduction
summary: Learn how to quickly start a TiDB cluster.
category: introduction
---

# TiDB Introduction

TiDB ("Ti" stands for Titanium) is an open-source NewSQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability.

TiDB can be deployed on-premise or in-cloud. The following deployment options are officially supported by PingCAP:

- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md): This guide describes how to deploy TiDB using Ansible. It is strongly recommended for production deployment.
- [Ansible Offline Deployment](/how-to/deploy/orchestrated/offline-ansible.md): If your environment has no access to the internet, you can follow this guide to see how to deploy a TiDB cluster offline using Ansible.
- [Docker Deployment](/how-to/deploy/orchestrated/docker.md): This guide describes how to deploy TiDB using Docker.
- [Docker Compose Deployment](/how-to/get-started/local-cluster/install-from-docker-compose.md): This guide describes how to deploy TiDB using Docker compose. You can follow this guide to quickly deploy a TiDB cluster for testing and development on your local drive.
- [Kubernetes Deployment (beta)](/how-to/get-started/local-cluster/install-from-kubernetes.md): This guide describes how to deploy TiDB on Kubernetes using [TiDB Operator](https://github.com/pingcap/tidb-operator). You can follow this guide to see how to deploy TiDB on Google Kubernetes Engine or deploy TiDB locally using Docker in Docker.
- [Binary Tarball Deployment](/how-to/deploy/from-tarball/production-environment.md): This guide describes how to deploy TiDB from a binary tarball in production. Guides for [development](/how-to/get-started/local-cluster/install-from-binary.md) and [testing](/how-to/deploy/from-tarball/testing-environment.md) environments are also available.

## Community Provided Blog Posts & Tutorials

The following list collects deployment guides and tutorials from the community. The content is subject to change by the contributors.

- [How To Spin Up an HTAP Database in 5 Minutes with TiDB + TiSpark](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/)
- [Developer install guide (single machine)](http://www.tocker.ca/this-blog-now-powered-by-wordpress-tidb.html)
- [TiDB Best Practices](https://pingcap.com/blog/2017-07-24-tidbbestpractice/)

_Your contribution is also welcome! Feel free to open a [pull request](https://github.com/pingcap/docs/blob/master/dev/overview.md) to add additional links._

## Source Code

Source code for [all components of the TiDB platform](https://github.com/pingcap) is available on GitHub.

- [TiDB](https://github.com/pingcap/tidb)
- [TiKV](https://github.com/tikv/tikv)
- [PD](https://github.com/pingcap/pd)
- [TiSpark](https://github.com/pingcap/tispark)
- [TiDB Operator](https://github.com/pingcap/tidb-operator)
@@ -4,7 +4,7 @@ jobs:
build:
docker:
- image: andelf/doc-build:0.1.9
working_directory: ~/pingcap/docs
working_directory: ~/pingcap/docs-cn
branches:
only:
- master
@@ -13,7 +13,7 @@ jobs:
- checkout

- run:
name: "Special Check for Golang User - YOUR TAB SUCKS"
name: "Special Check for Golang User"
command: grep -RP '\t' * | tee | grep '.md' && exit 1; echo ok

- run:
@@ -24,19 +24,25 @@ jobs:
name: "Generate PDF"
command: scripts/generate_pdf.sh

# echo "222.222.95.49 uc.qbox.me": adds a new host
- deploy:
name: "Publish PDF"
command: |
sudo bash -c 'echo "222.222.95.49 uc.qbox.me" >> /etc/hosts';
if [ "${CIRCLE_BRANCH}" == "master" ]; then
python3 scripts/upload.py output.pdf tidb-manual-en.pdf;
python3 scripts/upload.py dev/output.pdf tidb-manual-dev.pdf;
python3 scripts/upload.py v3.0/output.pdf tidb-manual-v3.0.pdf;
python3 scripts/upload.py v2.1/output.pdf tidb-manual-v2.1.pdf;
fi
if [ "${CIRCLE_BRANCH}" == "website-preview" ]; then
python3 scripts/upload.py output.pdf tidb-manual-en-preview.pdf;
python3 scripts/upload.py dev/output.pdf tidb-manual-dev-preview.pdf;
python3 scripts/upload.py v3.0/output.pdf tidb-manual-v3.0-preview.pdf;
python3 scripts/upload.py v2.1/output.pdf tidb-manual-v2.1-preview.pdf;
fi
- run:
name: "Copy Generated PDF"
command: mkdir /tmp/artifacts && cp output.pdf doc.md /tmp/artifacts
command: mkdir /tmp/artifacts && cp dev/output.pdf dev/doc.md v3.0/output.pdf v3.0/doc.md v2.1/output.pdf v2.1/doc.md /tmp/artifacts

- store_artifacts:
path: /tmp/artifacts

0 comments on commit df2a250

Please sign in to comment.
You can’t perform that action at this time.