Provide a workaround for windows users

adswa commented 4 years ago

Handbook starts with a text2git configuration, which uses mimeencoding since Dec 2019, but this is not included in git-annex: https://git-annex.branchable.com/todo/provide_windows_build_with_MagicMime/

discovered by @DorienHuijser -- thanks so much!

hey @all-contributors please add @DorienHuijser for bug userTesting

adswa commented 4 years ago

hey @all-contributors please add @DorienHuijser for bug userTesting

allcontributors[bot] commented 4 years ago

@adswa

I've put up a pull request to add @DorienHuijser! :tada:

adswa commented 4 years ago

I have looked in to this and it doesn't appear to be straightforward :( Neither mimetype nor mimeencoding work for for Windows to detect the file type, and textfiles will be placed in the annex (unless consistently saved using save --to-git). I see the following ways going forward:

the text2git configuration needs to be removed for windows users in any case. We should also add notes to the sections that explain this procedure (at least http://handbook.datalad.org/en/latest/basics/101-124-procedures.html)

Apart from that we could either:

remove it without a replacement. Its not super bad, because on a native windows installation the repository will be working in adjusted mode, so that annexed files are constantly unlocked and modifiable, but it will lead to inconsistencies starting with chapter 4 when textfiles are not available after cloning
add notes for windows users to consistently save any textfile with save --to-git. However, one save with --to-git will place the file into the annex and it will be a pain to get it out of there.

Both options are not optimal. I'm leaning towards the first, personally.

adswa commented 4 years ago

Yet another alternative: Go back to recommending the WSL option. But this is, again, suboptimal on so many levels...

adswa commented 4 years ago

After catching up a bit of sleep, I think the easiest solution are a few custom largefile rules inside of DataLad-101 that take the final dataset structure into account:

untested, no internet in train:

*.txt annex.largefiles=nothing
code/** annex.largefiles=nothing

adswa commented 4 years ago

done by #532.

datalad-handbook / book

Provide a workaround for windows users #529