Merge pull request #58 from nrc/mdbook

Add mdbook support

.gitignore

@@ -1,2 +1,3 @@
 .vscode/
 .DS_STORE
+book-out/

README.md

@@ -68,3 +68,8 @@ If you have questions about the SIG or transactions in TiKV, please get in touch
 * project: [Large transactions](https://github.com/tikv/tikv/projects/36),
 * project: [Green GC](https://github.com/tikv/tikv/projects/35),
 * project: [Parallel commit](https://github.com/tikv/tikv/projects/34).
+
+
+## Rendering documentation
+
+You can render the contents of this repo using mdbook, just run `mdbook build` in the top directory.

SUMMARY.md

@@ -0,0 +1,18 @@
+# Summary
+
+- [Repo information](README.md)
+
+# Documentation
+
+- [Transactions overview](doc/README.md)
+- [Transactions in TiKV](doc/tikv/README.md)
+
+# Design docs
+
+- [Proposal for refactoring how transactional commands are scheduled and implemented](design/transaction-layer-refactoring.md)
+- [Async commit](design/async-commit/README.md)
+    - [Project summary](design/async-commit/project-summary.md)
+    - [Initial design](design/async-commit/initial-design.md)
+    - [Non-unique timestamps](design/async-commit/globally-non-unique-timestamps.md)
+    - [Replica read](design/async-commit/replica-read.md)
+    - [Known issues](design/async-commit/parallel-commit-known-issues-and-solutions.md)

book.toml

@@ -0,0 +1,15 @@
+[book]
+title = "TiKV sig-transaction documentation"
+author = "TiKV transactions SIG"
+description = "Documentation of distributed transactions in TiDB and TiKV. Includes some coverage of general distributed transaction topics."
+src = "."
+
+[rust]
+edition = "2018"
+
+[build]
+build-dir = "book-out"
+create-missing = false
+
+[output.html]
+git-repository-url = "https://github.com/tikv/sig-transaction"