search

rustic-rs / docs

rustic user documentation
http://rustic.cli.rs/docs/
Mozilla Public License 2.0
9 stars 11 forks source link

Add examples for some storage providers #4

Open aawsome opened 1 year ago

aawsome commented 1 year ago

In the example dir, there is currently only a real-life example of using local storage and of using OVH cloud archive/cloud storage as hot/cold storage (which is what I am using). Some more real-life examples might be good, e.g. using AWS glacier/standard S3 as hot/cold storage or storages of the other big public clouds.

devhell commented 1 year ago

How do you want to implement documentation? Mdbook, or readthedocs, or something else?

aawsome commented 1 year ago

Actually I thought about something github is able to display directly like Markdown/reStructuredText. What I find most important is that we can make PRs which change functionality in the code and the docu at the same time!

If we can add something to automatically export this (to pdf, e.g.) in the CD pipeline that would be a bonus!

About the examples: Actually config .tomls with some comments are also fine. But yes, there might be some providers which need more configuration (like rclone, permissions etc.) so that could also fit in a docu.

devhell commented 1 year ago

I'll have a look at what I can figure out regarding the code documentation in Rust, but until then, how would you like to proceed with general documentation? I was thinking of something that helps people get started quickly and understand the basics of using rustic; particularly if they've not encountered restic before. And for those who are coming from restic, a quick overview of what, or what not, to expect (e.g., the rclone backend running SFTP).