diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 00000000000..e9329ff1915 --- /dev/null +++ b/.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 diff --git a/docs/README.md b/docs/README.md index a0019526e3f..934e6278aca 100644 --- a/docs/README.md +++ b/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 +``` diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 00000000000..b07f1eb3758 --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Jian Zhang"] +language = "en" +multilingual = false +src = "src" +title = "TiKV Java Client User Documents" diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md new file mode 100644 index 00000000000..33988271cef --- /dev/null +++ b/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) diff --git a/docs/configuration.md b/docs/src/administration/configuration.md similarity index 100% rename from docs/configuration.md rename to docs/src/administration/configuration.md diff --git a/docs/src/administration/introduction.md b/docs/src/administration/introduction.md new file mode 100644 index 00000000000..8c000cad2a6 --- /dev/null +++ b/docs/src/administration/introduction.md @@ -0,0 +1 @@ +# Administration diff --git a/docs/monitoring.md b/docs/src/administration/monitoring.md similarity index 100% rename from docs/monitoring.md rename to docs/src/administration/monitoring.md diff --git a/docs/src/architecture/availability.md b/docs/src/architecture/availability.md new file mode 100644 index 00000000000..2a2146c8212 --- /dev/null +++ b/docs/src/architecture/availability.md @@ -0,0 +1 @@ +# Availability: Backoff and Retry Policy diff --git a/docs/src/architecture/introduction.md b/docs/src/architecture/introduction.md new file mode 100644 index 00000000000..c79bec1ac69 --- /dev/null +++ b/docs/src/architecture/introduction.md @@ -0,0 +1 @@ +# Architecture diff --git a/docs/src/architecture/observability.md b/docs/src/architecture/observability.md new file mode 100644 index 00000000000..0ff363a9e51 --- /dev/null +++ b/docs/src/architecture/observability.md @@ -0,0 +1 @@ +# Observability: Slow Log and Metrics diff --git a/docs/src/architecture/region-cache.md b/docs/src/architecture/region-cache.md new file mode 100644 index 00000000000..77721cd7459 --- /dev/null +++ b/docs/src/architecture/region-cache.md @@ -0,0 +1 @@ +# Region Cache diff --git a/docs/src/architecture/request-lifecycle.md b/docs/src/architecture/request-lifecycle.md new file mode 100644 index 00000000000..a95445a2767 --- /dev/null +++ b/docs/src/architecture/request-lifecycle.md @@ -0,0 +1 @@ +# The Lifecycle of A Request diff --git a/docs/dev-guide.md b/docs/src/contribution/introduction.md similarity index 100% rename from docs/dev-guide.md rename to docs/src/contribution/introduction.md diff --git a/docs/src/examples/bulk-load.md b/docs/src/examples/bulk-load.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/docs/src/examples/introduction.md b/docs/src/examples/introduction.md new file mode 100644 index 00000000000..a48e8db34a8 --- /dev/null +++ b/docs/src/examples/introduction.md @@ -0,0 +1 @@ +# Start With Examples diff --git a/docs/src/examples/quick-start.md b/docs/src/examples/quick-start.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/docs/src/examples/rawkv.md b/docs/src/examples/rawkv.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/docs/src/examples/txnkv.md b/docs/src/examples/txnkv.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/docs/src/performance/introduction.md b/docs/src/performance/introduction.md new file mode 100644 index 00000000000..6babb314a57 --- /dev/null +++ b/docs/src/performance/introduction.md @@ -0,0 +1 @@ +# Performance diff --git a/docs/src/performance/ycsb.md b/docs/src/performance/ycsb.md new file mode 100644 index 00000000000..41f89447d00 --- /dev/null +++ b/docs/src/performance/ycsb.md @@ -0,0 +1 @@ +# YCSB Benchmarks diff --git a/docs/src/troubleshooting/error-request.md b/docs/src/troubleshooting/error-request.md new file mode 100644 index 00000000000..6f248ec1361 --- /dev/null +++ b/docs/src/troubleshooting/error-request.md @@ -0,0 +1 @@ +# Error Request Diagnosis diff --git a/docs/src/troubleshooting/introduction.md b/docs/src/troubleshooting/introduction.md new file mode 100644 index 00000000000..4f341277d35 --- /dev/null +++ b/docs/src/troubleshooting/introduction.md @@ -0,0 +1 @@ +# Troubleshooting diff --git a/docs/src/troubleshooting/slow-request.md b/docs/src/troubleshooting/slow-request.md new file mode 100644 index 00000000000..1de796a0ab8 --- /dev/null +++ b/docs/src/troubleshooting/slow-request.md @@ -0,0 +1 @@ +# Slow Request Diagnosis