Improve Documentation #72

New Issue

Closed

opened 2021-05-02 18:57:11 +00:00 by quentin · 0 comments

quentin commented

2021-05-02 18:57:11 +00:00

Owner

Some ideas to improve our documentation:

On main page:
- Remove the part about IMAP, it is too prospective for people that are not used to our already weird way of thinking ^^
- Clearly state our 3 features: Storage Backend, Backup/File Synchronization, Website Hosting and our main quality, something like: Internet-scale Resilient Data Storage
Create a Tutorial section (or Usage) that we subdivise in 3 sections following our 3 previous features (Storage Backend, Backup/File Synchronization, Website Hosting). In each, we would explain ways to use Garage with some tools:
- For Storage Backend, we would mention Nextcloud and Matrix Synapse (and maybe other ones?)
- For Backup/File Synchronization, we would mention s3cmd, minio, aws and rclone, cyberduck, duck (cyberduck cli) and maybe s3 browser
- For Website Hosting, we could simply put a note about previous tools + speak about Publii + maybe see if some static website tools integrate s3
In the cookbook section, we should explain how we can deploy Garage behind a reverse proxy
Add an "architecture" section where we mention our crdt/tables/merkle trees/anti entropy/maglev/etc.

Some ideas to improve our documentation: - On main page: - Remove the part about IMAP, it is too prospective for people that are not used to our already weird way of thinking ^^ - Clearly state our 3 features: Storage Backend, Backup/File Synchronization, Website Hosting and our main quality, something like: Internet-scale Resilient Data Storage - Create a Tutorial section (or Usage) that we subdivise in 3 sections following our 3 previous features (Storage Backend, Backup/File Synchronization, Website Hosting). In each, we would explain ways to use Garage with some tools: - For Storage Backend, we would mention Nextcloud and Matrix Synapse (and maybe other ones?) - For Backup/File Synchronization, we would mention s3cmd, minio, aws and rclone, cyberduck, duck (cyberduck cli) and maybe s3 browser - For Website Hosting, we could simply put a note about previous tools + speak about Publii + maybe see if some static website tools integrate s3 - In the cookbook section, we should explain how we can deploy Garage behind a reverse proxy - Add an "architecture" section where we mention our crdt/tables/merkle trees/anti entropy/maglev/etc.