aboutsummaryrefslogtreecommitdiff
path: root/doc/book/src/cookbook/index.md
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2021-05-31 17:13:36 +0200
committerAlex Auvolat <alex@adnab.me>2021-05-31 17:13:36 +0200
commitd76a8576f440a90d87fbeaabc80131eadafc88b7 (patch)
tree161128350c0b1af8415df195ffb001bf2a372e23 /doc/book/src/cookbook/index.md
parent289521886bc5819790c92da6cdf24898aacbaf58 (diff)
downloadgarage-d76a8576f440a90d87fbeaabc80131eadafc88b7.tar.gz
garage-d76a8576f440a90d87fbeaabc80131eadafc88b7.zip
Reorganize documentation
Diffstat (limited to 'doc/book/src/cookbook/index.md')
-rw-r--r--doc/book/src/cookbook/index.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/book/src/cookbook/index.md b/doc/book/src/cookbook/index.md
index 26ec68bb..a838b549 100644
--- a/doc/book/src/cookbook/index.md
+++ b/doc/book/src/cookbook/index.md
@@ -3,3 +3,23 @@
A cookbook, when you cook, is a collection of recipes.
Similarly, Garage's cookbook contains a collection of recipes that are known to works well!
This chapter could also be referred as "Tutorials" or "Best practices".
+
+- **[Deploying Garage](real_world.md):** This page will walk you through all of the necessary
+ steps to deploy Garaage in a real-world setting.
+
+- **[Configuring S3 clients](clients.md):** This page will explain how to configure
+ popular S3 clients to interact with a Garage server.
+
+- **[Hosting a website](website.md):** This page explains how to use Garage
+ to host a static website.
+
+- **[Recovering from failures](recovering.md):** Garage's first selling point is resilience
+ to hardware failures. This section explains how to recover from such a failure in the
+ best possible way.
+
+- **[Building from source](from_source.md):** This page explains how to build Garage from
+ source in case a binary is not provided for your architecture, or if you want to
+ hack with us!
+
+- **[Starting with Systemd](from_source.md):** This page explains how to run Garage
+ as a Systemd service (instead of as a Docker container).