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

Mention Notebook 7 and other lab-based applications in the extension development documentation #13758

Closed
jtpio opened this issue Jan 12, 2023 · 1 comment
Assignees
Milestone

Comments

@jtpio
Copy link
Member

jtpio commented Jan 12, 2023

Problem

Currently the documentation for authoring extensions mostly focuses on JupyterLab extensions: extensions meant to be used within the default JupyterLab application shell: https://jupyterlab.readthedocs.io/en/latest/extension/extension_points.html#jupyter-front-end-shell

Notebook 7 leverages the existing ecosystem of JupyterLab extensions: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html

Most extensions made for JupyterLab should also work with Notebook 7, although there are of course some differences between the two interfaces and shells.

Proposed Solution

We should mention there exists other lab-based applications and encourage extension authors to make extensions that will be compatible with them, not just with stock JupyterLab.

That could mean encouraging the use of optional dependencies, and explaining when using ILabShell is needed. But also mention there might be differences, for example an application might not have the command palette.

There could be a small section in the extension tutorial for example: https://jupyterlab.readthedocs.io/en/latest/extension/extension_tutorial.html. Maybe under an "Advanced" section, or on a dedicated docs page.

Additional context

This was discussed yesterday before and during the Notebook weekly call with @echarles @ericsnekbytes @RRosio @afshin: jupyter/notebook-team-compass#21 (comment)

@jupyterlab-probot jupyterlab-probot bot added the status:Needs Triage Applied to new issues that need triage label Jan 12, 2023
@jtpio jtpio added this to the 4.0.0 milestone Jan 12, 2023
@jtpio jtpio removed the status:Needs Triage Applied to new issues that need triage label Jan 12, 2023
@JasonWeill JasonWeill modified the milestones: 4.0.0, 4.1.0 Feb 1, 2023
@fcollonval fcollonval modified the milestones: 4.1.0, 4.0.0 Feb 2, 2023
@jtpio jtpio modified the milestones: 4.0.0, 4.0.x May 15, 2023
@jtpio
Copy link
Member Author

jtpio commented Mar 5, 2024

Closing as fixed by #14838

@jtpio jtpio closed this as completed Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants