🚀 MVP launch buttons for JupyterHub & MyBinder

jupyter-book / myst-theme

Packages for creating MyST websites themes using React and Remix

https://jupyter-book.github.io/myst-theme/?path=/docs/components-introduction--docs

MIT License

17 stars 15 forks source link

🚀 MVP launch buttons for JupyterHub & MyBinder #503

Open agoose77 opened 5 days ago

agoose77 commented 5 days ago

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

[ ] https://github.com/jupyter-book/mystmd/issues/1675
[ ] Move Thebe UX to same button
[ ] Support launch buttons that jump into specific blocks in JLab

changeset-bot[bot] commented 5 days ago

⚠️ No Changeset found

Latest commit: e2f97b837516c114bd589c22d6da185619977a5d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

agoose77 commented 5 days ago

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 commented 5 days ago

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.

agoose77 commented 1 day ago

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

screen

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.