🚀 MVP launch buttons for JupyterHub & MyBinder

[agoose77]

To close jupyter-book/mystmd#1643 and jupyter-book/mystmd#1644, this PR prototypes a launch UI. We will want to move things around in time, but this PR is designed to start design conversations.

There are some deeper conversations around environment provisioning, and execution strategies. They should be ignored for the purpose of this MVP.

Open questions

• It would be nice for the launch button to be sticky, but the current Thebe example feels a bit uncoupled from the rest of the document. How can we improve this?

Zero-mystmd-changes MVP

• Use HEAD
• Support bring-your-own Hub/Binder
• Use frontmatter-defined binder

Kitchen-sink solution

• Record Git SHA during build and expose in site config mystmd#1675
• Move Thebe UX to same button
• Support launch buttons that jump into specific blocks in JLab
  

[agoose77]

The first commit adds a basic launch popover from the frontmatter header icons:

I think this is a good spot for a launch button, as it's "per-document", and not too obtrusive. However, it's not necessarily a "frontmatter" feature, and perhaps is too unobtrusive.

In the long run, I'd like us to expose more features, like JupyterHub vs MyBinder, Deepnote, Colab, etc. These will probably be tabs within the popover. We should aim to support these kinds of options, but reducing the amount of input that the reader needs to handle.

For now, though, the goal of this prototype is to explore the MVP for a UX in order to identify changes in MyST-MD / MyST theme that will be necessary.

[choldgraf]

Quick thoughts from me:

• That location for a button seems natural, at least as a first step. The one other place I could imagine it would be next to the thebe button, which I think is floating to the bottom-right? But I think that could be a future enhancement.
• Agree tabs is worth exploring for different launch services. Though for now, just supporting one-or-more hard-coded BinderHub and JupyterHubs is fine.
• A "nice to have" would be allowing users to specify their own BinderHub / JupyterHub to launch, but I think that's not critical for an MVP.
• If JH doesn't have an ability to tell MyST whether it has image building functionality, let's just make the assumption that a hard-coded hub/Binder instance does, and scope the "discover if a Binder image can be built" task for a follow up

Overall - the UX you describe above seems like a good first step for an MVP - it roughly mimics the behavior of Jupyter Book and would let users get started if they were already relying on that feature.

[stevejpurves]

👍🏼

[stevejpurves]

should we generalize in our naming a bit more? as in:

git: <url>
provider: 'github'

thebe does that, as the intention is to support git interface/protocol.

or are we happy with

github: 'https://gitlab.myinstitution.org/...'

Also I realise that we only have github in the frontmatter, but I am imagining that this git info will in future come from a more dedicated frontmatter.services block or the like which may have non github specific fields, like the one I suggest there.

[agoose77]

Yes, entirely! I'm going to take inspiration from some of the jb1 config here.

[agoose77]

I think we do need to change our frontmatter; GitHub should not be the only Git repo that we can define in our frontmatter.

I would probably have frontmatter fields for github, gitlab, etc. that are normalised to a git field i.e. mystmd should know how to build canonical URLs for those providers.

[rowanc1]

💯

[agoose77]

I've added support for basic validation using Radix Form:

I think this is good to go for a WIP. I'm keen to ship this in time for AGU, so I'm not exporting it intentionally. We can also disable it by default if that provides less concern for @stevejpurves et al. to ship.

Any review welcome.