Code Monkey home page Code Monkey logo

pingcap-docs's Introduction

TiDB Documentation

This repository stores all the source files of TiDB Docs at the PingCAP website, while the pingcap/docs-cn repository stores all the source files of TiDB Documentation in Chinese. If you find documentation issues, feel free to create an Issue to let us know or directly create a Pull Request to help fix or update it.

Docs structure

The general TiDB documentation structure is as follows:

├── TOC.md
├── how-to
    ├── get-started
    ├── deploy
        ├── orchestrated
            ├── ansible.md
            ├── offline-ansible.md
            ├── docker.md
    ├── configure
    ├── maintain
    ├── troubleshoot
    ├── ...
├── reference
   ├── tools
    ├── tidb-binlog
    ├── ...
├── releases
├── tidb-in-kubernetes
├── faq
├── ...
...

Contributing

See TiDB Documentation Contributing Guide to get started. 🤓

pingcap-docs's People

Contributors

amyangfei avatar aylei avatar caitinchen avatar cofyc avatar danielzhangqd avatar dcalvin avatar disksing avatar ericsyh avatar huachaohuang avatar huangxiuyan avatar ianthereal avatar izabelwang avatar junlan-zhang avatar kennytm avatar kolbe avatar lilin90 avatar linuxgit avatar morgo avatar queenyjin avatar ran-huang avatar rleungx avatar shenli avatar siddontang avatar tiancaiamao avatar tomshawn avatar toutdesuite avatar wenting0905 avatar xuechunl avatar yikeke avatar yinixu9506 avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.