garage/doc/book/reference-manual/_index.md

+++
title = "Reference Manual"
weight = 5
sort_by = "weight"
template = "documentation.html"
+++

A reference manual contains some extensive descriptions about the features and the behaviour of the software.
Reading of this chapter is recommended once you have a good knowledge/understanding of Garage.
It will be useful if you want to tune it or to use it in some exotic conditions.
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> 2022-02-07 10:51:12 +00:00			`+++`
			`title = "Reference Manual"`
Add a "build" section, doc for SDK 2022-11-13 15:48:23 +00:00			`weight = 5`
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> 2022-02-07 10:51:12 +00:00			`sort_by = "weight"`
			`template = "documentation.html"`
			`+++`
Working on the getting started guide 2021-03-17 16:24:11 +00:00
			`A reference manual contains some extensive descriptions about the features and the behaviour of the software.`
			`Reading of this chapter is recommended once you have a good knowledge/understanding of Garage.`
			`It will be useful if you want to tune it or to use it in some exotic conditions.`