aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/book/src/SUMMARY.md23
-rw-r--r--doc/book/src/compatibility.md1
-rw-r--r--doc/book/src/cookbook/index.md1
-rw-r--r--doc/book/src/cookbook/website.md (renamed from doc/book/src/website.md)0
-rw-r--r--doc/book/src/design/index.md1
-rw-r--r--doc/book/src/design/internals.md (renamed from doc/book/src/internals.md)0
-rw-r--r--doc/book/src/design/related_work.md (renamed from doc/book/src/related_work.md)0
-rw-r--r--doc/book/src/development/devenv.md (renamed from doc/book/src/devenv.md)0
-rw-r--r--doc/book/src/development/index.md1
-rw-r--r--doc/book/src/getting_started/index.md (renamed from doc/book/src/getting_started.md)0
-rw-r--r--doc/book/src/intro.md24
-rw-r--r--doc/book/src/reference_manual/index.md1
-rw-r--r--doc/book/src/reference_manual/s3_compatibility.md (renamed from doc/book/src/S3_Compatibility.md)0
-rw-r--r--doc/book/src/working_documents/index.md7
-rw-r--r--doc/book/src/working_documents/load_balancing.md (renamed from doc/Load_Balancing.md)2
15 files changed, 50 insertions, 11 deletions
diff --git a/doc/book/src/SUMMARY.md b/doc/book/src/SUMMARY.md
index 5d01dbee..7697948b 100644
--- a/doc/book/src/SUMMARY.md
+++ b/doc/book/src/SUMMARY.md
@@ -2,25 +2,28 @@
[The Garage Data Store](./intro.md)
-- [Getting Started](./getting_started.md)
+- [Getting Started](./getting_started/index.md)
- [Installation](./getting_started/install.md)
- [Configure a cluster](./getting_started/cluster.md)
- [Create buckets and keys](./getting_started/bucket.md)
- [Handle files](./getting_started/files.md)
-- [Cookbooks]()
- - [Host a website](./website.md)
+- [Cookbook](./cookbook/index.md)
+ - [Host a website](./cookbook/website.md)
- [Integrate as a media backend]()
- [Operate a cluster]()
-- [Reference Manual]()
+- [Reference Manual](./reference_manual/index.md)
- [Garage CLI]()
- - [S3 API](./compatibility.md)
+ - [S3 API](./reference_manual/s3_compatibility.md)
-- [Design]()
- - [Related Work](./related_work.md)
- - [Internals](./internals.md)
+- [Design](./design/index.md)
+ - [Related Work](./design/related_work.md)
+ - [Internals](./design/internals.md)
-- [Development]()
- - [Setup your environment](./devenv.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)
diff --git a/doc/book/src/compatibility.md b/doc/book/src/compatibility.md
deleted file mode 100644
index acf9968b..00000000
--- a/doc/book/src/compatibility.md
+++ /dev/null
@@ -1 +0,0 @@
-# S3 API
diff --git a/doc/book/src/cookbook/index.md b/doc/book/src/cookbook/index.md
new file mode 100644
index 00000000..741ecbe7
--- /dev/null
+++ b/doc/book/src/cookbook/index.md
@@ -0,0 +1 @@
+# Cookbook
diff --git a/doc/book/src/website.md b/doc/book/src/cookbook/website.md
index 2ea82a9a..2ea82a9a 100644
--- a/doc/book/src/website.md
+++ b/doc/book/src/cookbook/website.md
diff --git a/doc/book/src/design/index.md b/doc/book/src/design/index.md
new file mode 100644
index 00000000..3d14cb7c
--- /dev/null
+++ b/doc/book/src/design/index.md
@@ -0,0 +1 @@
+# Design
diff --git a/doc/book/src/internals.md b/doc/book/src/design/internals.md
index e712ae07..e712ae07 100644
--- a/doc/book/src/internals.md
+++ b/doc/book/src/design/internals.md
diff --git a/doc/book/src/related_work.md b/doc/book/src/design/related_work.md
index bae4691c..bae4691c 100644
--- a/doc/book/src/related_work.md
+++ b/doc/book/src/design/related_work.md
diff --git a/doc/book/src/devenv.md b/doc/book/src/development/devenv.md
index 6cb7c554..6cb7c554 100644
--- a/doc/book/src/devenv.md
+++ b/doc/book/src/development/devenv.md
diff --git a/doc/book/src/development/index.md b/doc/book/src/development/index.md
new file mode 100644
index 00000000..459110d3
--- /dev/null
+++ b/doc/book/src/development/index.md
@@ -0,0 +1 @@
+# Development
diff --git a/doc/book/src/getting_started.md b/doc/book/src/getting_started/index.md
index 282f5034..282f5034 100644
--- a/doc/book/src/getting_started.md
+++ b/doc/book/src/getting_started/index.md
diff --git a/doc/book/src/intro.md b/doc/book/src/intro.md
index ec77036f..02920f83 100644
--- a/doc/book/src/intro.md
+++ b/doc/book/src/intro.md
@@ -60,6 +60,30 @@ In a certain way, Ceph and Minio are closer togethers than they are from Garage
*More comparisons are available in our [Related Work](design/related_work.md) chapter.*
+## Other Resources
+
+This website is not the only source of information about Garage!
+We reference here other places on the Internet where you can learn more about Garage.
+
+### Rust API (docs.rs)
+
+If you encounter a specific bug in Garage or plan to patch it, you may jump directly to the source code documentation!
+
+ - [garage\_api](https://docs.rs/garage_api/latest/garage_api/) - contains the S3 standard API endpoint
+ - [garage\_model](https://docs.rs/garage_model/latest/garage_model/) - contains Garage's model built on the table abstraction
+ - [garage\_rpc](https://docs.rs/garage_rpc/latest/garage_rpc/) - contains Garage's federation protocol
+ - [garage\_table](https://docs.rs/garage_table/latest/garage_table/) - contains core Garage's CRDT datatypes
+ - [garage\_util](https://docs.rs/garage_util/latest/garage_util/) - contains garage entrypoints (daemon, cli)
+ - [garage\_web](https://docs.rs/garage_web/latest/garage_web/) - contains the S3 website endpoint
+
+### Talks
+
+We love to talk and hear about Garage, that's why we keep a log here:
+
+ - [(fr, 2020-12-02) Garage : jouer dans la cour des grands quand on est un hébergeur associatif](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/master/doc/20201202_talk/talk.pdf)
+
+*Did you write or talk about Garage? [Open a pull request](https://git.deuxfleurs.fr/Deuxfleurs/garage/) to add a link here!*
+
## Community
If you want to discuss with us, you can join our Matrix channel at [#garage:deuxfleurs.fr](https://matrix.to/#/#garage:deuxfleurs.fr).
diff --git a/doc/book/src/reference_manual/index.md b/doc/book/src/reference_manual/index.md
new file mode 100644
index 00000000..a2f380f6
--- /dev/null
+++ b/doc/book/src/reference_manual/index.md
@@ -0,0 +1 @@
+# Reference Manual
diff --git a/doc/book/src/S3_Compatibility.md b/doc/book/src/reference_manual/s3_compatibility.md
index c0fc2863..c0fc2863 100644
--- a/doc/book/src/S3_Compatibility.md
+++ b/doc/book/src/reference_manual/s3_compatibility.md
diff --git a/doc/book/src/working_documents/index.md b/doc/book/src/working_documents/index.md
new file mode 100644
index 00000000..6eb7eccb
--- /dev/null
+++ b/doc/book/src/working_documents/index.md
@@ -0,0 +1,7 @@
+# Working Documents
+
+Working documents are documents that reflect the fact that Garage is a software that evolves quickly.
+They are a way to communicate our ideas, our changes, and so on.
+
+Ideally, while the feature/patch has been merged, the working document should serve as a source to
+update the rest of the documentation.
diff --git a/doc/Load_Balancing.md b/doc/book/src/working_documents/load_balancing.md
index a348ebc4..f0f1a4d4 100644
--- a/doc/Load_Balancing.md
+++ b/doc/book/src/working_documents/load_balancing.md
@@ -1,3 +1,5 @@
+## Load Balancing Data
+
I have conducted a quick study of different methods to load-balance data over different Garage nodes using consistent hashing.
### Requirements