Skip to content

Use binder directory for configuration files #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 15, 2020

Conversation

matthewfeickert
Copy link
Contributor

In response to @ericmjl's tweet RE: Binder configuration file conflicts, this PR adopts the use of a binder directory for configuration files which eliminates any conflict as

If a binder/ folder is used, Binder will only read configuration files from that location (i.e. myproject/binder/requirements.txt) and will ignore those in the repository’s root

As placing the Conda environment.yml config file affects the path that both the user focused documentation and the CI use, paths and docs that explicitly use the path to the config file are updated.

As this does now require users to think more explicitly about the path to the environment.yml at environment creation time I can understand that this might be something that could be a deal breaker for this PR. However, I think that most people should be fine with typing a few more letters and probably don't deeply care where their environment config files live.

This also reverts the movement of the Dockerfile and the .dockerignore as this was just done to avoid the issue, but there is no reason to do this anymore so don't.

Finally, the Binder badge used is updated to reflect the modern (as of 2019) Binder badge (with logo).

@matthewfeickert
Copy link
Contributor Author

For reference, the Binder build for this branch on my fork is here: https://mybinder.org/v2/gh/matthewfeickert/bayesian-stats-modelling-tutorial/use-binder-dir-example

@ericmjl
Copy link
Owner

ericmjl commented Feb 15, 2020

Wonderful stuff, @matthewfeickert!

@ericmjl ericmjl merged commit 7fc3d82 into ericmjl:master Feb 15, 2020
@ericmjl
Copy link
Owner

ericmjl commented Feb 15, 2020

I appreciate all the thought you put into the PR, @matthewfeickert. This is how open source is supposed to be done! 😄

@matthewfeickert matthewfeickert deleted the use-binder-dir-example branch February 15, 2020 06:27
@matthewfeickert
Copy link
Contributor Author

Ah, thank you @ericmjl! That's so kind of you to say. 🙂

The work that you do for the Python community (like this true gem of a tutorial repo) is truly inspirational and I'm more then pleased if I can have helped out in a very small way.

@hugobowne
Copy link
Collaborator

Echoing sentiments in both directions here :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants