search

plasmabio / template-bash

Plasma template environment for Bash
BSD 3-Clause "New" or "Revised" License
0 stars 4 forks source link

Store environment config files in a `binder` directory ? #2

Closed pierrepo closed 4 years ago

pierrepo commented 4 years ago

It might be a good practice to keep all config files of the environment in a binder directory. This is enabled by repod2docker.

This would prevent the user from seeing files he doesn't need (in the first place).

We may then bring notebooks and files from the materials directory back to the root directory of the env.

Could you share your thoughs on this @jtpio ?

jtpio commented 4 years ago

Sounds good :+1:

Many repos adopt this convention to keep things tidy indeed.

.binder/ would also work, since the notebook and lab interfaces do not show hidden files by default?

pierrepo commented 4 years ago

.binder/ would also work, since the notebook and lab interfaces do not show hidden files by default?

Absolutely. But I'd like to let more curious students engage with the env by keeping the binder directory available.

From a teaching point-of-view, this is also a very good opportunity to speak about reproducibility: "All the things you have to now about your env is in binder/" ;-)

jtpio commented 4 years ago

Good points.

Then binder/ sounds like the best option.

pierrepo commented 4 years ago

Awesome @jtpio I'll update the template repo soon.