garage/doc/book/working-documents/_index.md at 5c00c9fb46305b021b5fc45d7ae7b1e13b72030c

continuous-integration/drone/push Build is passing

Details

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: #213
Co-authored-by: Alex <alex@adnab.me>
Co-committed-by: Alex <alex@adnab.me>

2022-02-07 11:51:12 +01:00

584 B

Raw Blame History

+++ title = "Working Documents" weight = 7 sort_by = "weight" template = "documentation.html" +++

Working documents are documents that reflect the fact that Garage is a software that evolves quickly. They are a way to communicate our ideas, our changes, and so on before or while we are implementing them in Garage. If you like to live on the edge, it could also serve as a documentation of our next features to be released.

Ideally, once the feature/patch has been merged, the working document should serve as a source to update the rest of the documentation and then be removed.

584 B Raw Blame History

584 B

Raw Blame History