search

scratcharchive / kachery

Content-addressable storage server with Python client
Apache License 2.0
6 stars 2 forks source link

tutorial improvements #3

Open ahbarnett opened 4 years ago

ahbarnett commented 4 years ago

Hi Jeremy, I like most of the documentation, but think it needs to be expanded in 2 ways: 1) including more example use-cases up front in the intro. Why do people/labs need this? 2) Tutorial needs to include the basic set-up for local directory. Eg when I install and run kachery-store on a directory, it says WARNING: please use the KACHERY_STORAGE_DIR environment variable. and apparently nothing is stored (this feels more like an ERROR than a warning). I did export KACHERY_STORAGE_DIR=/tmp/ and then it works and creates /tmp/sha1/ and /tmp/sha1-cache/ I think you need to guide the user through that process, encourage them to look at the result.

Only then move on to the remote server aspect. The docker-instructions for remote server is a little loose too - what is magland/kachery2 supposed to be for the user? An example set-up is needed here, maybe some flow diagrams. Best, Alex

magland commented 4 years ago

Thanks Alex. The warning about KACHERY_STORAGE_DIR is only a warning because by default it should use the /tmp directory. I guess we should verify that this is indeed the case.

I have updated the README to instruct the user on how to set up the KACHERY_STORAGE_DIR, and I also provide a quick motivating example. The tutorial should be expanded to further motivate using kachery.