search

jupyterhub / mybinder.org-user-guide

Turn a Git repo into a collection of interactive notebooks. This is Binder's user documentation repository.
https://mybinder.readthedocs.io
BSD 3-Clause "New" or "Revised" License
156 stars 103 forks source link

Document how to add a "run with Binder" bot using GitHub actions #202

Closed choldgraf closed 4 years ago

choldgraf commented 4 years ago

I believe in various threads I've seen @hamelsmu show off some pretty nifty GitHub actions to generate Binder badges for PRs and display them in the PR thread. This seems like a nicely-contained feature that we should highlight somewhere! Maybe in these docs? Maybe @hamelsmu would be willing to write up a short-and-sweet description of how to use this that we could add in to the documentation, and link out to the GHA docs for more detailed information?

hamelsmu commented 4 years ago

Would be happy to do this

hamelsmu commented 4 years ago

@choldgraf I am looking into this now, can you point me at where I can contribute to the docs? For example, I'm trying to learn about how this page was made but I cannot seem to find that page in this repository. Any hints here?

Thank you

choldgraf commented 4 years ago

Hey - ah I think you have run into some sub-optimal documentation practices from us 😬

In an effort to cut down on the duplicated documentation, we've been pulling in pages from the repo2docker documentation into the binder documentation at build time. here's the script that does this:

https://github.com/jupyterhub/binder/blob/master/doc/conf.py#L183

so where you'd actually need to update that file is https://github.com/jupyter/repo2docker/blob/master/docs/source/howto/languages.rst

sorry that is confusing :-/ we should probably revisit this practice...

hamelsmu commented 4 years ago

Ahhh any tips on how I can preview the docs locally so I can test a PR locally before submission?

P.S. I will probably have to take a rst tutorial before doing this, but I'm ok with that

choldgraf commented 4 years ago

hmmm - maybe this is a good time to enable the MyST markdown parser in the repository (https://myst-parser.readthedocs.io)...if you like we can hop on a quick call maybe tomorrow PM and I can step you through the docs build?

and when you build the docs locally those files should be downloaded into your local repository (they are just ignored in git), so maybe you could download them once, then comment-out those lines so they don't get re-downloaded, and you can start playing around w/ editing the text?

you are making me further question the decision to build the docs in this way haha

hamelsmu commented 4 years ago

Ok having a call would be really great, I will take you up on that offer. I'll DM you to setup a time