diff options
| author | Alex <alex@adnab.me> | 2022-02-07 11:51:12 +0100 |
|---|---|---|
| committer | Alex <alex@adnab.me> | 2022-02-07 11:51:12 +0100 |
| commit | 1c0ba930b8d6aa5d97e6942852240861e6ab9bed (patch) | |
| tree | cddc9af5fc2378c76fe5ef6306f807e27648b7a7 /doc/book/src/cookbook/index.md | |
| parent | 45d6d377d2011d8fb4ceb13bb4584df97c458525 (diff) | |
| download | garage-1c0ba930b8d6aa5d97e6942852240861e6ab9bed.tar.gz garage-1c0ba930b8d6aa5d97e6942852240861e6ab9bed.zip | |
Reorganize documentation for new website (#213)
This PR should be merged after the new website is deployed.
- [x] Rename files
- [x] Add front matter section to all `.md` files in the book (necessary for Zola)
- [x] Change all internal links to use Zola's linking system that checks broken links
- [x] Some updates to documentation contents and organization
Co-authored-by: Alex Auvolat <alex@adnab.me>
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/213
Co-authored-by: Alex <alex@adnab.me>
Co-committed-by: Alex <alex@adnab.me>
Diffstat (limited to 'doc/book/src/cookbook/index.md')
| -rw-r--r-- | doc/book/src/cookbook/index.md | 26 |
1 files changed, 0 insertions, 26 deletions
diff --git a/doc/book/src/cookbook/index.md b/doc/book/src/cookbook/index.md deleted file mode 100644 index 792a5e6e..00000000 --- a/doc/book/src/cookbook/index.md +++ /dev/null @@ -1,26 +0,0 @@ -# Cookbook - -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". - -- **[Multi-node deployment](real_world.md):** This page will walk you through all of the necessary - steps to deploy Garage in a real-world setting. - -- **[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! - -- **[Integration with Systemd](systemd.md):** This page explains how to run Garage - as a Systemd service (instead of as a Docker container). - -- **[Configuring a gateway node](gateways.md):** This page explains how to run a gateway node in a Garage cluster, i.e. a Garage node that doesn't store data but accelerates access to data present on the other nodes. - -- **[Hosting a website](exposing_websites.md):** This page explains how to use Garage - to host a static website. - -- **[Configuring a reverse-proxy](reverse_proxy.md):** This page explains how to configure a reverse-proxy to add TLS support to your S3 api endpoint. - -- **[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. |