Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pingcap/tidb-dev-guide
A comprehensive development guide to help you be more and more familiar with the TiDB community and become an expert finally.
https://github.com/pingcap/tidb-dev-guide
development distributed-database guide tidb
Last synced: about 1 month ago
JSON representation
A comprehensive development guide to help you be more and more familiar with the TiDB community and become an expert finally.
- Host: GitHub
- URL: https://github.com/pingcap/tidb-dev-guide
- Owner: pingcap
- Created: 2021-05-03T12:21:47.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-18T15:04:28.000Z (3 months ago)
- Last Synced: 2024-12-18T16:35:18.307Z (about 1 month ago)
- Topics: development, distributed-database, guide, tidb
- Homepage: https://pingcap.github.io/tidb-dev-guide/
- Size: 21.6 MB
- Stars: 118
- Watchers: 33
- Forks: 62
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# TiDB Development Guide
This repository contains the source of TiDB Development Guide.
* The target audience of this guide is TiDB contributors, both new and experienced.
* The objective of this guide is to help contributors become an expert of TiDB, who is familiar with its design and implementation and thus is able to use it fluently in the real world as well as develop TiDB itself deeply.
## Requirements
Building the book requires [mdBook](https://github.com/rust-lang-nursery/mdBook). To get it:
```bash
$ cargo install mdbook
```
## Building
To build the book, type:
```bash
$ mdbook build
```
The output will be in the `book` subdirectory. To check it out, open it in
your web browser.
_Firefox:_
```bash
$ firefox book/index.html # Linux
$ open -a "Firefox" book/index.html # OS X
$ Start-Process "firefox.exe" .\book\index.html # Windows (PowerShell)
$ start firefox.exe .\book\index.html # Windows (Cmd)
```
_Chrome:_
```bash
$ google-chrome book/index.html # Linux
$ open -a "Google Chrome" book/index.html # OS X
$ Start-Process "chrome.exe" .\book\index.html # Windows (PowerShell)
$ start chrome.exe .\book\index.html # Windows (Cmd)
```
## Contribute to this guide
See [CONTRIBUTING](CONTRIBUTING.md) for details.