search

nuest / ten-simple-rules-dockerfiles

Ten Simple Rules for Writing Dockerfiles for Reproducible Data Science
https://doi.org/10.1371/journal.pcbi.1008316
Creative Commons Attribution 4.0 International
61 stars 15 forks source link

Rule consistency #79

Closed bdevans closed 4 years ago

bdevans commented 4 years ago

This address issue #76.

I have made the agreed changes and also trimmed the text down to be more focussed on reproducibility where appropriate.

Unfortunately I forgot to pull the upstream changes since I forked the repository so may need some help resolving the merge conflicts - sorry!

bdevans commented 4 years ago

Hi @nuest, if you're happy to merge this, I can take a look at the other issues later today. (I think it's best to do them sequentially otherwise there will likely be lots of merge conflicts due to the significant restructuring of the rules.)

bdevans commented 4 years ago

Ok just one remaining issue for this - should I change back the paths in the bind mount example to absolute or leave them with the $HOME var?

nuest commented 4 years ago

@bdevans I think we want people to use relative paths, because full paths are a pain.

That said, I think we should only use that if we find a very concise way of explaining that getting the current working path is very different across systems, and. Maybe a short comment _"$PROJECT_HOME holds the path to the current project directory"_ (to avoid the $HOME Unix users might be familiar with) ?

If that get's too complicated, let's use full paths for now.

bdevans commented 4 years ago

Ok @nuest, does the new sentence cover it?

nuest commented 4 years ago

It did - but the one example that explicitly mentioned relative paths led me to keep pwd in - let's see what the reviewers say.