aboutsummaryrefslogtreecommitdiff
path: root/content/documentation/cookbook
diff options
context:
space:
mode:
authorsptaule <lecas83@gmail.com>2022-01-25 15:27:39 +0100
committersptaule <lecas83@gmail.com>2022-01-25 15:27:39 +0100
commitee4d6a01e16ac53fa3e48340a47455281d5f6bc0 (patch)
tree98d21309e281ea02ed5fe2b12187b211f761f385 /content/documentation/cookbook
parentada5e9ac0e6e1e226534a463238b06930ba58b64 (diff)
downloadgaragehq.deuxfleurs.fr-ee4d6a01e16ac53fa3e48340a47455281d5f6bc0.tar.gz
garagehq.deuxfleurs.fr-ee4d6a01e16ac53fa3e48340a47455281d5f6bc0.zip
Organized doc md with metadata & draft for doc template
Diffstat (limited to 'content/documentation/cookbook')
-rw-r--r--content/documentation/cookbook/_index.md6
-rw-r--r--content/documentation/cookbook/exposing_websites.md4
-rw-r--r--content/documentation/cookbook/from_source.md4
-rw-r--r--content/documentation/cookbook/gateways.md4
-rw-r--r--content/documentation/cookbook/index.md31
-rw-r--r--content/documentation/cookbook/real_world.md4
-rw-r--r--content/documentation/cookbook/recovering.md4
-rw-r--r--content/documentation/cookbook/reverse_proxy.md4
-rw-r--r--content/documentation/cookbook/systemd.md4
-rw-r--r--content/documentation/cookbook/website.md8
10 files changed, 20 insertions, 53 deletions
diff --git a/content/documentation/cookbook/_index.md b/content/documentation/cookbook/_index.md
new file mode 100644
index 0000000..c788f18
--- /dev/null
+++ b/content/documentation/cookbook/_index.md
@@ -0,0 +1,6 @@
++++
+title="Cookbook"
+weight = 2
+sort_by = "weight"
+redirect_to = "documentation/cookbook/real-world/"
++++ \ No newline at end of file
diff --git a/content/documentation/cookbook/exposing_websites.md b/content/documentation/cookbook/exposing_websites.md
index 1b55a08..e592e6c 100644
--- a/content/documentation/cookbook/exposing_websites.md
+++ b/content/documentation/cookbook/exposing_websites.md
@@ -1,6 +1,6 @@
+++
-title="Doc Post"
-date=2018-08-20
+title = "Exposing buckets as websites"
+weight = 25
+++
# Exposing buckets as websites
diff --git a/content/documentation/cookbook/from_source.md b/content/documentation/cookbook/from_source.md
index 38ede4d..f33b7ab 100644
--- a/content/documentation/cookbook/from_source.md
+++ b/content/documentation/cookbook/from_source.md
@@ -1,6 +1,6 @@
+++
-title="Doc Post"
-date=2018-08-20
+title = "Compiling Garage from source"
+weight = 10
+++
# Compiling Garage from source
diff --git a/content/documentation/cookbook/gateways.md b/content/documentation/cookbook/gateways.md
index f176c5e..8bd3a66 100644
--- a/content/documentation/cookbook/gateways.md
+++ b/content/documentation/cookbook/gateways.md
@@ -1,6 +1,6 @@
+++
-title="Doc Post"
-date=2018-08-20
+title = "Configuring a gateway node"
+weight = 20
+++
# Gateways
diff --git a/content/documentation/cookbook/index.md b/content/documentation/cookbook/index.md
deleted file mode 100644
index 764ee0c..0000000
--- a/content/documentation/cookbook/index.md
+++ /dev/null
@@ -1,31 +0,0 @@
-+++
-title="Doc Post"
-date=2018-08-20
-+++
-
-# 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.
diff --git a/content/documentation/cookbook/real_world.md b/content/documentation/cookbook/real_world.md
index 7d6d77e..049a54a 100644
--- a/content/documentation/cookbook/real_world.md
+++ b/content/documentation/cookbook/real_world.md
@@ -1,6 +1,6 @@
+++
-title="Doc Post"
-date=2018-08-20
+title = "Multi-node deployment"
+weight = 5
+++
# Deploying Garage on a real-world cluster
diff --git a/content/documentation/cookbook/recovering.md b/content/documentation/cookbook/recovering.md
index 2b8e2f0..7d75bfe 100644
--- a/content/documentation/cookbook/recovering.md
+++ b/content/documentation/cookbook/recovering.md
@@ -1,6 +1,6 @@
+++
-title="Doc Post"
-date=2018-08-20
+title = "Recovering from failures"
+weight = 35
+++
# Recovering from failures
diff --git a/content/documentation/cookbook/reverse_proxy.md b/content/documentation/cookbook/reverse_proxy.md
index 36d3535..36b9ea3 100644
--- a/content/documentation/cookbook/reverse_proxy.md
+++ b/content/documentation/cookbook/reverse_proxy.md
@@ -1,6 +1,6 @@
+++
-title="Doc Post"
-date=2018-08-20
+title = "Configuring a reverse proxy"
+weight = 30
+++
# Configuring a reverse proxy
diff --git a/content/documentation/cookbook/systemd.md b/content/documentation/cookbook/systemd.md
index cb40b6a..8e812e1 100644
--- a/content/documentation/cookbook/systemd.md
+++ b/content/documentation/cookbook/systemd.md
@@ -1,6 +1,6 @@
+++
-title="Doc Post"
-date=2018-08-20
+title = "Starting Garage with systemd"
+weight = 15
+++
# Starting Garage with systemd
diff --git a/content/documentation/cookbook/website.md b/content/documentation/cookbook/website.md
deleted file mode 100644
index a5e378f..0000000
--- a/content/documentation/cookbook/website.md
+++ /dev/null
@@ -1,8 +0,0 @@
-+++
-title="Doc Post"
-date=2018-08-20
-+++
-
-# Hosting a website
-
-TODO