diff options
| author | Alex Auvolat <alex@adnab.me> | 2022-02-02 10:05:27 +0100 |
|---|---|---|
| committer | Alex Auvolat <alex@adnab.me> | 2022-02-07 11:47:51 +0100 |
| commit | ff04afaa771e1ec2bd482fa47ced1a8e4933c916 (patch) | |
| tree | c2e0962ed5e672aea733607e4c16ac37e3b2b40d /doc/book/development/_index.md | |
| parent | 45d6d377d2011d8fb4ceb13bb4584df97c458525 (diff) | |
| download | garage-ff04afaa771e1ec2bd482fa47ced1a8e4933c916.tar.gz garage-ff04afaa771e1ec2bd482fa47ced1a8e4933c916.zip | |
Move documentation files around and adapt format for new website
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 |