Skip to content

A comprehensive development guide to help you be more and more familiar with the TiDB community and become an expert finally.

Notifications You must be signed in to change notification settings

TonsnakeLin/tidb-dev-guide

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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. To get it:

$ cargo install mdbook

Building

To build the book, type:

$ mdbook build

The output will be in the book subdirectory. To check it out, open it in your web browser.

Firefox:

$ 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:

$ 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 for details.

About

A comprehensive development guide to help you be more and more familiar with the TiDB community and become an expert finally.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published