full document support

[zz-jason]

Is your feature request related to a problem? Please describe.

make users know how to config, use, and monitor the client.

Describe the solution you'd like

• Examples in using java client
• Config document
• API document generated by javadoc
• Monitor and Alert
• Troubleshoot
• Performance Tuning
• FAG

Describe alternatives you've considered

N/A

Additional context

N/A

[zz-jason]

How to maintain the document

1. Putting the source code to the docs directory
2. Using mdbook to generate the doc
3. Add GitHub pages in this repo to show the rendered documents
4. Auto-generate the rendered documents via GitHub actions or Travis CI in each PR

A simple document structure

• Examples

  • Quick Start
  • Interact with TiKV RawKV API
  • Interact with TiKV TxnKV API
  • TiKV RawKV Bulk Load

• Performance

  • YCSB Benchmarks

• Administration

  • Configuration
  • Monitoring

• Troubleshooting

  • Slow Request Diagnosis
  • Error Request Diagnosis

• Architecture

  • The Lifecycle of A Request
  • Availability: Backoff and Retry Policy
  • Observability: Slow Log and Metrics
  • Region Cache