Remove most h1 titles that weren't needed

This commit is contained in:
Alex 2022-01-31 16:43:48 +01:00
parent fba1b06503
commit c16116559d
No known key found for this signature in database
GPG key ID: EDABF9711E244EB1
31 changed files with 2 additions and 36 deletions

View file

@ -3,8 +3,6 @@ title = "Apps (Nextcloud, Peertube...)"
weight = 5
+++
# Apps (Nextcloud, Peertube...)
In this section, we cover the following software: [Nextcloud](#nextcloud), [Peertube](#peertube), [Mastodon](#mastodon), [Matrix](#matrix)
## Nextcloud

View file

@ -3,7 +3,6 @@ title = "Backups (restic, duplicity...)"
weight = 25
+++
# Backups (restic, duplicity...)
Backups are essential for disaster recovery but they are not trivial to manage.
Using Garage as your backup target will enable you to scale your storage as needed while ensuring high availability.

View file

@ -3,7 +3,6 @@ title = "CLI tools"
weight = 20
+++
# CLI tools
CLI tools allow you to query the S3 API without too many abstractions.
These tools are particularly suitable for debug, backups, website deployments or any scripted task that need to handle data.

View file

@ -3,7 +3,6 @@ title = "Your code (PHP, JS, Go...)"
weight = 30
+++
# Your code (PHP, JS, Go...)
If you are developping a new application, you may want to use Garage to store your user's media.

View file

@ -3,7 +3,6 @@ title = "FUSE (s3fs, goofys, s3backer...)"
weight = 25
+++
# FUSE (s3fs, goofys, s3backer...)
**WARNING! Garage is not POSIX compatible.
Mounting S3 buckets as filesystems will not provide POSIX compatibility.

View file

@ -3,7 +3,6 @@ title = "Repositories (Docker, Nix, Git...)"
weight = 15
+++
# Repositories (Docker, Nix, Git...)
Whether you need to store and serve binary packages or source code, you may want to deploy a tool referred as a repository or registry.
Garage can also help you serve this content.

View file

@ -3,7 +3,6 @@ title = "Websites (Hugo, Jekyll, Publii...)"
weight = 10
+++
# Websites (Hugo, Jekyll, Publii...)
Garage is also suitable to host static websites.
While they can be deployed with traditional CLI tools, some static website generators have integrated options to ease your workflow.

View file

@ -3,8 +3,6 @@ title = "Exposing buckets as websites"
weight = 25
+++
# Exposing buckets as websites
You can expose your bucket as a website with this simple command:
```bash

View file

@ -3,7 +3,6 @@ title = "Compiling Garage from source"
weight = 10
+++
# Compiling Garage from source
Garage is a standard Rust project.

View file

@ -3,7 +3,6 @@ title = "Configuring a gateway node"
weight = 20
+++
# Gateways
Gateways allow you to expose Garage endpoints (S3 API and websites) without storing data on the node.

View file

@ -1,10 +1,8 @@
+++
title = "Multi-node deployment"
title = "Deployment on a cluster"
weight = 5
+++
# Deploying Garage on a real-world cluster
To run Garage in cluster mode, we recommend having at least 3 nodes.
This will allow you to setup Garage for three-way replication of your data,
the safest and most available mode proposed by Garage.

View file

@ -3,7 +3,6 @@ title = "Recovering from failures"
weight = 35
+++
# Recovering from failures
Garage is meant to work on old, second-hand hardware.
In particular, this makes it likely that some of your drives will fail, and some manual intervention will be needed.

View file

@ -3,7 +3,6 @@ title = "Configuring a reverse proxy"
weight = 30
+++
# Configuring a reverse proxy
The main reason to add a reverse proxy in front of Garage is to provide TLS to your users.

View file

@ -3,7 +3,6 @@ title = "Starting Garage with systemd"
weight = 15
+++
# Starting Garage with systemd
We make some assumptions for this systemd deployment.

View file

@ -3,7 +3,6 @@ title = "Benchmarks"
weight = 10
+++
# Benchmarks
With Garage, we wanted to build a software defined storage service that follow the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle),
that is suitable for geo-distributed deployments and more generally that would work well for community hosting (like a Mastodon instance).

View file

@ -3,7 +3,6 @@ title = "Goals and use cases"
weight = 5
+++
# Goals and use cases
## Goals and non-goals

View file

@ -3,7 +3,6 @@ title = "Internals"
weight = 20
+++
# Internals
## Overview

View file

@ -3,7 +3,6 @@ title = "Related work"
weight = 15
+++
# Related work
## Context

View file

@ -3,7 +3,6 @@ title = "Setup your environment"
weight = 5
+++
# Setup your development environment
Depending on your tastes, you can bootstrap your development environment in a traditional Rust way or through Nix.

View file

@ -3,7 +3,6 @@ title = "Miscellaneous notes"
weight = 20
+++
# Miscellaneous Notes
## Quirks about cargo2nix/rust in Nix

View file

@ -3,7 +3,6 @@ title = "Release process"
weight = 15
+++
# Release process
Before releasing a new version of Garage, our code pass through a succession of checks and transformations.
We define them as our release process.

View file

@ -3,7 +3,6 @@ title = "Development scripts"
weight = 10
+++
# Development scripts
We maintain a `script/` folder that contains some useful script to ease testing on Garage.

View file

@ -3,7 +3,6 @@ title = "Garage CLI"
weight = 15
+++
# Garage CLI
The Garage CLI is mostly self-documented. Make use of the `help` subcommand
and the `--help` flag to discover all available options.

View file

@ -1,9 +1,8 @@
+++
title = "Garage configuration file"
title = "Configuration file format"
weight = 5
+++
# Garage configuration file format reference
Here is an example `garage.toml` configuration file that illustrates all of the possible options:

View file

@ -3,7 +3,6 @@ title = "Cluster layout management"
weight = 10
+++
# Creating and updating a cluster layout
The cluster layout in Garage is a table that assigns to each node a role in
the cluster. The role of a node in Garage can either be a storage node with

View file

@ -3,7 +3,6 @@ title = "S3 Compatibility status"
weight = 20
+++
# S3 Compatibility status
## Global S3 features

View file

@ -3,7 +3,6 @@ title = "S3 compatibility target"
weight = 5
+++
# S3 compatibility target
If there is a specific S3 functionnality you have a need for, feel free to open
a PR to put the corresponding endpoints higher in the list. Please explain

View file

@ -3,7 +3,6 @@ title = "Design draft"
weight = 25
+++
# Design draft
**WARNING: this documentation is a design draft which was written before Garage's actual implementation.
The general principle are similar, but details have not been updated.**

View file

@ -3,7 +3,6 @@ title = "Load balancing data"
weight = 10
+++
# Load Balancing Data (planned for version 0.2)
**This is being yet improved in release 0.5. The working document has not been updated yet, it still only applies to Garage 0.2 through 0.4.**

View file

@ -3,7 +3,6 @@ title = "Migrating from 0.3 to 0.4"
weight = 20
+++
# Migrating from 0.3 to 0.4
**Migrating from 0.3 to 0.4 is unsupported. This document is only intended to
document the process internally for the Deuxfleurs cluster where we have to do

View file

@ -3,7 +3,6 @@ title = "Migrating from 0.5 to 0.6"
weight = 15
+++
# Migrating from 0.5 to 0.6
**This guide explains how to migrate to 0.6 if you have an existing 0.5 cluster.
We don't recommend trying to migrate directly from 0.4 or older to 0.6.**