Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Agree on terminology for "interactive kernel" functionality #1645

Open
choldgraf opened this issue Nov 15, 2024 · 1 comment
Open

Agree on terminology for "interactive kernel" functionality #1645

choldgraf opened this issue Nov 15, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@choldgraf
Copy link
Collaborator

In #1235 we had a mixup in terminology, and we should align on this as a term.

@choldgraf used "launch button" to mean "a button that takes a reader out of the current page and puts them into a live JupyterHub or BinderHub session".

@stevejpurves used "launch button" to mean "the button that spins up Thebe and powers a page with a Jupyter kernel so it's interactive.

The Jupyter Book docs use "Launch button" as a parent term that applies to both. It doesn't provide a specific word to differentiate "live code with thebe" but implies that it's also a launch button.

We should pick terminology to use for these two different use-cases so that we don't confuse users (or ourselves)

Proposal

  • Use Launch to mean directing a user to a live session on JupyterHub/Binder/Colab/etc.
  • Use Interact or Power to mean "connecting a MyST page with a Jupyter kernel on the backend to render its content interactive.

Rationale

My primary rationale is that this is roughly the terminology that Jupyter Book has been using for a few years, given that Thebe is less common than direct Binder/JupyterHub launches. I'm not a huge fan of the specific words, if somebody has a better suggestion I'm definitely open to it.

@agoose77
Copy link
Contributor

I think this is a good distinction. To me, "Launch" means "Jump elsewhere", so your distinction works well for me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants