Add Docs for Binder Badge w/GitHub Actions

[hamelsmu]

Summary of changes made:

• Updated conf.py while pair programming with @choldgraf, to enable MyST parser
• Added a how-to guide for using Actions to comment on a PR with a binder badge.
• Added dependency of myst_parser to doc-requirements.txt

Thanks to @choldgraf for pair programming with me and getting me started.

cc: @betatim

Closes #202 (added by @consideRatio)

[welcome]

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please make sure you followed the pull request template, as this will help us review your contribution more quickly.

You can meet the other Jovyans by joining our Discourse forum. There is also a intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

[hamelsmu]

@choldgraf stuck on this one, not sure how to resolve the readthedocs error, does anything stick out to you?

[choldgraf]

A few quick comments but in general this is looking great!

[hamelsmu]

Reposting this comment from @choldgraf as a reminder of TODO for myself:

it would be awesome if you could somehow automate the process of "only trigger this action on a PR from a fork if /binder is added by a member of the GitHub organization that owns the main repo. And if the PR is from within the same repo, trigger /binder for a comment from anyone

[hamelsmu]

@choldgraf

it would be awesome if you could somehow automate the process of "only trigger this action on a PR from a fork if /binder is added by a member of the GitHub organization that owns the main repo. And if the PR is from within the same repo, trigger /binder for comment from anyone

I addressed this with another example and more explanation. I didn't want to overly complicate the issue, so I provided the building blocks of how you can achieve this with a more simple example and let the user decide what to do themselves. What do you think?

[consideRatio]

This LGTM, there are still some open discussions not yet resolved, but other than that I think this is excellent!

I'm very happy to have learned more about GitHub actions and MyST by reviewing this excellent documentation! Excellent work @hamelsmu! ❤️ 🎉

[hamelsmu]

@consideRatio

there are still some open discussions not yet resolved

What is not resolved? Please let me know!

[consideRatio]

there are still some open discussions not yet resolved

Nothing any more, you quickly resolved them =) This LGTM! +1 for merge @choldgraf!

[hamelsmu]

Oh wait, maybe I messed up the title of this it is not supposed to be capitalized, it seems 🤦 my apologies

EDIT: ☝️ Fixed it 🎉 LOL

[hamelsmu]

@consideRatio I'm going to start calling you the "human" linter 🎉 I got to get whatever IDE plugins you are using! Sharp eye for spacing

[consideRatio]

Final fix so it doesn't get lost in the big thread: #203 (review)

[hamelsmu]

Final fix so it doesn't get lost in the big thread: #203 (review)

Fixed it in d72a4b2

[consideRatio]

LGTM thanks @hamelsmu!!! ❤️

[choldgraf]

Alright this LGTM as well - thanks all for all of the helpful comments and iteration! And congrats @hamelsmu on figuring out how Sphinx works! You are in rarefied air 😅

Thanks for this contribution!

[welcome]

Congrats on your first merged pull request in this project! 🎉

Thank you for contributing, we are very proud of you! ❤️

[choldgraf]

It's alive! https://mybinder.readthedocs.io/en/latest/howto/gh-actions-badges.html