mybinder.org-user-guide icon indicating copy to clipboard operation
mybinder.org-user-guide copied to clipboard

Intro to Binder

Open choldgraf opened this issue 7 years ago • 3 comments

I think there would be value in creating a subset of the docs that covered "intro to Binder". Maybe something like:

  1. Conceptual overview of Binder + the tech that it uses
  2. The concept of config files for Binder
  3. A super-simple guide to creating a binder-ready repo (e.g. one notebook + one reqs.txt file)
  4. An explanation of Binder links and how to generate them
  5. A few common use-cases for other config files to show off functionality.
  6. Pointers to some particularly cool repositories for next steps.
  7. What happens under-the-hood when somebody clicks a Binder link

Both @ctb @betatim had thoughts on this in the gitter, I believe

choldgraf avatar Jan 12 '18 17:01 choldgraf

What do you think of having this as "Quick start" or "Tutorial" section in the binder docs? Maybe that was the plan all along :) I think right now in the docs we transmit a lot of facts, but we aren't sooo good at explaining "why" the facts are the way they are. So 👍 .

betatim avatar Jan 13 '18 08:01 betatim

Yep that's what I'm thinking too!

On Sat, Jan 13, 2018, 12:11 AM Tim Head [email protected] wrote:

What do you think of having this as "Quick start" or "Tutorial" in the binder docs? Maybe that was the plan all along :)

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/jupyterhub/binder/issues/60#issuecomment-357417861, or mute the thread https://github.com/notifications/unsubscribe-auth/ABwSHasaKWgxI32w_0gHdPVU1HzysmtPks5tKGVKgaJpZM4RcnWK .

choldgraf avatar Jan 13 '18 15:01 choldgraf

note that this is partially touched on here: https://mybinder.readthedocs.io/en/latest/introduction.html but there are definitely still improvements to be made

choldgraf avatar Feb 06 '18 01:02 choldgraf