diff options
| author | Alex <alex@adnab.me> | 2022-02-07 11:51:12 +0100 |
|---|---|---|
| committer | Alex <alex@adnab.me> | 2022-02-07 11:51:12 +0100 |
| commit | 1c0ba930b8d6aa5d97e6942852240861e6ab9bed (patch) | |
| tree | cddc9af5fc2378c76fe5ef6306f807e27648b7a7 /doc/book/development/_index.md | |
| parent | 45d6d377d2011d8fb4ceb13bb4584df97c458525 (diff) | |
| download | garage-1c0ba930b8d6aa5d97e6942852240861e6ab9bed.tar.gz garage-1c0ba930b8d6aa5d97e6942852240861e6ab9bed.zip | |
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>
Diffstat (limited to 'doc/book/development/_index.md')
| -rw-r--r-- | doc/book/development/_index.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/book/development/_index.md b/doc/book/development/_index.md new file mode 100644 index 00000000..662ec358 --- /dev/null +++ b/doc/book/development/_index.md @@ -0,0 +1,19 @@ ++++ +title = "Development" +weight = 6 +sort_by = "weight" +template = "documentation.html" ++++ + +Now that you are a Garage expert, you want to enhance it, you are in the right place! +We discuss here how to hack on Garage, how we manage its development, etc. + +## Rust API (docs.rs) +If you encounter a specific bug in Garage or plan to patch it, you may jump directly to the source code's documentation! + + - [garage\_api](https://docs.rs/garage_api/latest/garage_api/) - contains the S3 standard API endpoint + - [garage\_model](https://docs.rs/garage_model/latest/garage_model/) - contains Garage's model built on the table abstraction + - [garage\_rpc](https://docs.rs/garage_rpc/latest/garage_rpc/) - contains Garage's federation protocol + - [garage\_table](https://docs.rs/garage_table/latest/garage_table/) - contains core Garage's CRDT datatypes + - [garage\_util](https://docs.rs/garage_util/latest/garage_util/) - contains garage helpers + - [garage\_web](https://docs.rs/garage_web/latest/garage_web/) - contains the S3 website endpoint |