diff options
| author | sptaule <lecas83@gmail.com> | 2022-01-24 20:58:36 +0100 |
|---|---|---|
| committer | sptaule <lecas83@gmail.com> | 2022-01-24 20:58:36 +0100 |
| commit | dc932f973593747697b98aa612a308df889741ab (patch) | |
| tree | d1b88306af8373d650161e845c26690a52e32d29 /content/documentation/development/index.md | |
| parent | 336fd3f7566c7872c17b30f7cd150e1d16899205 (diff) | |
| download | garagehq.deuxfleurs.fr-dc932f973593747697b98aa612a308df889741ab.tar.gz garagehq.deuxfleurs.fr-dc932f973593747697b98aa612a308df889741ab.zip | |
Added doc book
Diffstat (limited to 'content/documentation/development/index.md')
| -rw-r--r-- | content/documentation/development/index.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/content/documentation/development/index.md b/content/documentation/development/index.md new file mode 100644 index 0000000..09147ec --- /dev/null +++ b/content/documentation/development/index.md @@ -0,0 +1,14 @@ +# Development + +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 |