aboutsummaryrefslogtreecommitdiff
path: root/doc/book/src/SUMMARY.md
diff options
context:
space:
mode:
authorAlex <alex@adnab.me>2021-03-18 10:39:55 +0100
committerAlex <alex@adnab.me>2021-03-18 10:39:55 +0100
commit5b659b28ce6bef15072d2fc93f777aa8ff73b2d8 (patch)
treee7ec9ec9dae459aeb6a99b35c537d46745053ec0 /doc/book/src/SUMMARY.md
parent6a3dcf39740cda27e61b93582b6fea66991ec4f2 (diff)
parentea21c544343afeb37e96678089bcd535e64982a7 (diff)
downloadgarage-5b659b28ce6bef15072d2fc93f777aa8ff73b2d8.tar.gz
garage-5b659b28ce6bef15072d2fc93f777aa8ff73b2d8.zip
Merge pull request 'Add a `mdbook` documentation to present garage and help user on-boarding' (#45) from feature/mdbook into master
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/45
Diffstat (limited to 'doc/book/src/SUMMARY.md')
-rw-r--r--doc/book/src/SUMMARY.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/book/src/SUMMARY.md b/doc/book/src/SUMMARY.md
new file mode 100644
index 00000000..7c435f23
--- /dev/null
+++ b/doc/book/src/SUMMARY.md
@@ -0,0 +1,31 @@
+# Summary
+
+[The Garage Data Store](./intro.md)
+
+- [Getting Started](./getting_started/index.md)
+ - [Get a binary](./getting_started/binary.md)
+ - [Configure the daemon](./getting_started/daemon.md)
+ - [Control the daemon](./getting_started/control.md)
+ - [Configure a cluster](./getting_started/cluster.md)
+ - [Create buckets and keys](./getting_started/bucket.md)
+ - [Handle files](./getting_started/files.md)
+
+- [Cookbook](./cookbook/index.md)
+ - [Host a website](./cookbook/website.md)
+ - [Integrate as a media backend]()
+ - [Operate a cluster]()
+
+- [Reference Manual](./reference_manual/index.md)
+ - [Garage CLI]()
+ - [S3 API](./reference_manual/s3_compatibility.md)
+
+- [Design](./design/index.md)
+ - [Related Work](./design/related_work.md)
+ - [Internals](./design/internals.md)
+
+- [Development](./development/index.md)
+ - [Setup your environment](./development/devenv.md)
+ - [Your first contribution]()
+
+- [Working Documents](./working_documents/index.md)
+ - [Load Balancing Data](./working_documents/load_balancing.md)