aboutsummaryrefslogtreecommitdiff
path: root/doc/book/working-documents/_index.md
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2022-02-02 10:05:27 +0100
committerAlex Auvolat <alex@adnab.me>2022-02-07 11:47:51 +0100
commitff04afaa771e1ec2bd482fa47ced1a8e4933c916 (patch)
treec2e0962ed5e672aea733607e4c16ac37e3b2b40d /doc/book/working-documents/_index.md
parent45d6d377d2011d8fb4ceb13bb4584df97c458525 (diff)
downloadgarage-ff04afaa771e1ec2bd482fa47ced1a8e4933c916.tar.gz
garage-ff04afaa771e1ec2bd482fa47ced1a8e4933c916.zip
Move documentation files around and adapt format for new website
Diffstat (limited to 'doc/book/working-documents/_index.md')
-rw-r--r--doc/book/working-documents/_index.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/book/working-documents/_index.md b/doc/book/working-documents/_index.md
new file mode 100644
index 00000000..9871d206
--- /dev/null
+++ b/doc/book/working-documents/_index.md
@@ -0,0 +1,13 @@
++++
+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.