adding binder folder text #56
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
willingc
reviewed
Dec 28, 2017
doc/using.rst
Outdated
| @@ -20,6 +20,10 @@ your Binder repository should contain at least: | |||
| * One (or many) text files that specify the requirements of your code. | |||
| For a complete list, see :ref:`config-files`. | |||
|
|
|||
| Configuration text files should be either in the **root** of your | |||
| repository, or in a folder in the root of the repository that is called | |||
| ``binder``. E.g., ``myrepo/binder/requirements.txt``. | |||
There was a problem hiding this comment.
Let's indent this to be part of the bullet in line 20.
- Configuration files (one or more text files) that specify the requirements of building your project's code.
For a complete list of supported files, see :ref:config-files. Configuration files may be placed in the
root of your repository or in abinderfolder in the repository's root (i.e.myproject/binder/).
If abinderfolder is used, Binder will only read configuration files from that location and will ignore
those in the repository's root.
willingc
reviewed
Dec 28, 2017
doc/faq.rst
Outdated
| ├── myfile.py | ||
| └── requirements.txt | ||
|
|
||
| In this case, only the ``requirments.txt`` file inside ``binder/`` will be |
There was a problem hiding this comment.
Configuration files may be placed in the root of your repository or in a binder folder in the repository's root (i.e. myproject/binder/). 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 (myproject/environment.yml and myproject/requirements.txt).
|
thx for the comments @willingc , changes made! |
|
Bimbambosh! Thanks for making the effort of writing it down 📝 |
This was referenced May 8, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds more language explaining the usage of the
binder/folder, as a number of people keep asking questions about whether this is possible. (e.g. jupyterhub/binderhub#381)cc @betatim