[to #348] use mdbook and github action to maintain documents (#407)

.github/workflows/gh-pages.yml

@@ -0,0 +1,30 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-20.04
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: '0.4.8'
+          # mdbook-version: 'latest'
+
+      - run: mdbook build ./docs
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/book

docs/README.md

@@ -1,10 +1,28 @@
 # Client Java Docs
 
-## Administration
+NOTE: See [tikv.github.io/client-java](https://tikv.github.io/client-java/) for
+the rendered developer and contributor documents.
 
-- [Configuration](./configuration.md)
-- [Monitoring](./monitoring.md)
+This directory contains all the source of developer and contributor
+documentations in markdown format. The table of content can be found in
+[./src/SUMMARY.md](./src/SUMMARY.md).
 
-## How to contribute
+## How to contribute to the document
 
-- [Contribution Guide](./dev-guide.md)
+The rendered document is generated by `mdbook`, to get it:
+
+```sh
+cargo install mdbook
+```
+
+Build the source in your development machine:
+
+```sh
+mdbook build
+```
+
+Get more information about how to use `mdbook`:
+
+```sh
+mdbook help
+```

docs/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["Jian Zhang"]
+language = "en"
+multilingual = false
+src = "src"
+title = "TiKV Java Client User Documents"

docs/src/SUMMARY.md

@@ -0,0 +1,26 @@
+# Summary
+
+- [Start With Examples](./examples/introduction.md)
+    - [Quick Start](./examples/quick-start.md)
+    - [Interact with TiKV RawKV API](./examples/rawkv.md)
+    - [Interact with TiKV TxnKV API](./examples/txnkv.md)
+    - [TiKV RawKV Bulk Load](./examples/bulk-load.md)
+
+- [Performance](./performance/introduction.md)
+    - [YCSB Benchmarks](./performance/ycsb.md)
+
+- [Administration](./administration/introduction.md)
+    - [Configuration](./administration/configuration.md)
+    - [Monitoring](./administration/monitoring.md)
+
+- [Troubleshooting](./troubleshooting/introduction.md)
+    - [Slow Request Diagnosis](./troubleshooting/slow-request.md)
+    - [Error Request Diagnosis](./troubleshooting/error-request.md)
+
+- [Architecture and Internals](./architecture/introduction.md)
+    - [The Lifecycle of A Request](./architecture/request-lifecycle.md)
+    - [Backoff and Retry Policy](./architecture/availability.md)
+    - [Slow Log and Metrics](./architecture/observability.md)
+    - [Region Cache](./architecture/region-cache.md)
+
+- [Contribution Guide](./contribution/introduction.md)

docs/src/administration/introduction.md

@@ -0,0 +1 @@
+# Administration

docs/src/architecture/availability.md

@@ -0,0 +1 @@
+# Availability: Backoff and Retry Policy

docs/src/architecture/introduction.md

@@ -0,0 +1 @@
+# Architecture

docs/src/architecture/observability.md

@@ -0,0 +1 @@
+# Observability: Slow Log and Metrics

docs/src/architecture/region-cache.md

@@ -0,0 +1 @@
+# Region Cache

docs/src/architecture/request-lifecycle.md

@@ -0,0 +1 @@
+# The Lifecycle of A Request

docs/src/examples/introduction.md

@@ -0,0 +1 @@
+# Start With Examples

docs/src/performance/introduction.md

@@ -0,0 +1 @@
+# Performance

docs/src/performance/ycsb.md

@@ -0,0 +1 @@
+# YCSB Benchmarks

docs/src/troubleshooting/error-request.md

@@ -0,0 +1 @@
+# Error Request Diagnosis

docs/src/troubleshooting/introduction.md

@@ -0,0 +1 @@
+# Troubleshooting

docs/src/troubleshooting/slow-request.md

@@ -0,0 +1 @@
+# Slow Request Diagnosis