Coder Social home page Coder Social logo

tidb-in-action's Introduction

Gitbook

Read it:TiDB In Action: based on 4.0

如何贡献

从 目录 找到还没有被认领的章节。参考 PR/3 提交一个 Pull Request 请求认领，当请求被合并之后就算认领成功。

文章内容格式采用 markdown. Github 简易入门指南

图片目录

请把图片放在 res/sessionX/chapterY/ 目录。举个例子, 文章 session1/chapter1/tidb-intro.md 中的图片应该放在 /res/session1/chapter1/tidb-intro/ 目录下，对应到 markdown 中的格式是 ![1.png](/res/session1/chapter1/tidb-intro/1.png)

TiDB in Action 写作规则

TiDB in Action 是一本重视实操的书，更偏向工具的介绍和使用，介绍原理部分会比较少，而且会尽量通过宏观的描述或者图片的形式表达。

好的例子

关于特性和产品介绍

  • 介绍工具的简单原理
  • 介绍工具如何使用（常见的参数，常见的应用场景）
  • 给出一两个简单的例子

关于最佳实践

  • 力求用文字或图清晰按照时间轴描述整个过程
    • 事前准备
    • 事中操作流程
    • 事后
  • 轻原理，重实操

不好的例子

  • 贴原理实现的代码
  • 直接复制粘贴案例，但是无操作流程
  • 对工具只介绍，不给例子
  • 选择的例子是个特例（不可复现）

License

Shield: CC BY-SA 4.0

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

CC BY-SA 4.0

tidb-in-action's People

Contributors

winkyao avatar c4pt0r avatar kissmydb avatar qiuyesuifeng avatar you06 avatar 154650362 avatar watchpoints avatar ilovesoup2000 avatar danielzhangqd avatar zz-jason avatar wilanhuang avatar hsqlu avatar soline324 avatar marsdai avatar zgcbj avatar zhuboshuai avatar fredbjer avatar ngaut avatar superlzs0476 avatar rusonding avatar vincent178 avatar xlows-1227 avatar breezewish avatar caohe avatar pengji avatar yangwenmai avatar tsthght avatar benmaoer avatar andrewdi avatar lonng avatar

Watchers

James Cloos 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.