Refactor file organization

This commit is contained in:
Quentin 2021-03-17 16:15:18 +01:00
parent c50113acf3
commit 002538f92c
15 changed files with 50 additions and 11 deletions

View file

@ -2,25 +2,28 @@
[The Garage Data Store](./intro.md)
- [Getting Started](./getting_started.md)
- [Getting Started](./getting_started/index.md)
- [Installation](./getting_started/install.md)
- [Configure a cluster](./getting_started/cluster.md)
- [Create buckets and keys](./getting_started/bucket.md)
- [Handle files](./getting_started/files.md)
- [Cookbooks]()
- [Host a website](./website.md)
- [Cookbook](./cookbook/index.md)
- [Host a website](./cookbook/website.md)
- [Integrate as a media backend]()
- [Operate a cluster]()
- [Reference Manual]()
- [Reference Manual](./reference_manual/index.md)
- [Garage CLI]()
- [S3 API](./compatibility.md)
- [S3 API](./reference_manual/s3_compatibility.md)
- [Design]()
- [Related Work](./related_work.md)
- [Internals](./internals.md)
- [Design](./design/index.md)
- [Related Work](./design/related_work.md)
- [Internals](./design/internals.md)
- [Development]()
- [Setup your environment](./devenv.md)
- [Development](./development/index.md)
- [Setup your environment](./development/devenv.md)
- [Your first contribution]()
- [Working Documents](./working_documents/index.md)
- [Load Balancing Data](./working_documents/load_balancing.md)

View file

@ -1 +0,0 @@
# S3 API

View file

@ -0,0 +1 @@
# Cookbook

View file

@ -0,0 +1 @@
# Design

View file

@ -0,0 +1 @@
# Development

View file

@ -60,6 +60,30 @@ In a certain way, Ceph and Minio are closer togethers than they are from Garage
*More comparisons are available in our [Related Work](design/related_work.md) chapter.*
## Other Resources
This website is not the only source of information about Garage!
We reference here other places on the Internet where you can learn more about Garage.
### 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 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 entrypoints (daemon, cli)
- [garage\_web](https://docs.rs/garage_web/latest/garage_web/) - contains the S3 website endpoint
### Talks
We love to talk and hear about Garage, that's why we keep a log here:
- [(fr, 2020-12-02) Garage : jouer dans la cour des grands quand on est un hébergeur associatif](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/master/doc/20201202_talk/talk.pdf)
*Did you write or talk about Garage? [Open a pull request](https://git.deuxfleurs.fr/Deuxfleurs/garage/) to add a link here!*
## Community
If you want to discuss with us, you can join our Matrix channel at [#garage:deuxfleurs.fr](https://matrix.to/#/#garage:deuxfleurs.fr).

View file

@ -0,0 +1 @@
# Reference Manual

View file

@ -0,0 +1,7 @@
# Working Documents
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.
Ideally, while the feature/patch has been merged, the working document should serve as a source to
update the rest of the documentation.

View file

@ -1,3 +1,5 @@
## Load Balancing Data
I have conducted a quick study of different methods to load-balance data over different Garage nodes using consistent hashing.
### Requirements