Skip to content

Commit 68f10a2

Browse files
ericsnekbytesjtpio
andauthored
Added extra information and user-action summaries to 7 migration docs. (#6850)
* Added extra information and user-action summaries to 7 migration docs. * Update docs/source/migrate_to_notebook7.md Co-authored-by: Jeremy Tuloup <[email protected]> * Update docs/source/migrate_to_notebook7.md Co-authored-by: Jeremy Tuloup <[email protected]> * Updated nbclassic messaging. * Revised heading. * Updated heading. * Formatting pass. --------- Co-authored-by: Jeremy Tuloup <[email protected]>
1 parent 787339c commit 68f10a2

File tree

1 file changed

+51
-14
lines changed

1 file changed

+51
-14
lines changed

docs/source/migrate_to_notebook7.md

+51-14
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,62 @@
11
# Migrating to Notebook 7
22

3-
```{warning}
4-
The Jupyter Notebook application is undergoing a major refactoring to
5-
improve the user experience and to make it easier to maintain and extend.
3+
_Updated 2023-04-24_
64

7-
This set of migration guides are intended to help you migrate your Classic Notebook
8-
setup and extensions to the new Jupyter Notebook 7, which is built on top of JupyterLab 4.
5+
```{warning}
6+
The Jupyter Notebook application's newest version 7 upgrade might break your
7+
extensions or other customizations, please read more below to find out if you
8+
need to take any actions to ensure a smooth, uninterrupted experience
99
```
1010

11-
## Sunrising the Jupyter Notebook 7
11+
A major upgrade to the Jupyter Notebook interface is coming with Notebook 7! This
12+
upgrade will bring a heap of new features, but will also break backwards
13+
compatibility with many classic Notebook features and customizations.
14+
15+
This set of guides is here to help you migrate your Classic Notebook setup and
16+
extensions to the new Notebook 7.
17+
18+
## What you need to do
19+
20+
For users who don't use extensions or other customizations, you will seamlessly
21+
receive the new Notebook 7 when you `pip install notebook` once version 7 is
22+
released out of beta, along with all its new features, like realtime
23+
collaboration, debugger, and theming.
24+
25+
For users who need to use extensions or other customizations, you have a couple
26+
of options:
27+
28+
- Look for Notebook 7 compatible versions of the extensions you already use,
29+
and [find replacements for those that are not available]
30+
31+
- If you need to maintain compatibility with the Classic Notebook for extensions
32+
or other customizations that are critical to your workflows, you can switch to
33+
[nbclassic], which will provide compatibility with the old notebook interface
34+
and support during an intermediate transition period to Notebook 7
35+
36+
## Why a new version?
1237

13-
For the past few years, the Classic Jupyter Notebook has been in maintenance mode.
38+
For the past few years, the Classic Jupyter Notebook has been in maintenance
39+
mode.
1440

15-
Development has mostly moved to alternative user interfaces like JupyterLab, which is a more
16-
modern and extensible web application. This has resulted in a lot of new
17-
features and improvements in JupyterLab, but also in a lot of new features and
18-
improvements that were not possible to integrate to the Classic Notebook.
41+
Development has mostly moved to alternative user interfaces like JupyterLab,
42+
which is a more modern and extensible web application. This has resulted in
43+
a lot of new features and improvements in JupyterLab, but also in a lot of
44+
new features and improvements that were not possible to integrate to the
45+
Classic Notebook.
1946

20-
For a while the plan was to progressively _sunset_ the Classic Notebook and not maintain it anymore. However, the Classic Notebook is still widely used and it is still the default user interface for Jupyter in many scenarios. Many users and organizations have not been able to switch to JupyterLab yet. For some users, JupyterLab can also be a more complex environment to use, especially for beginners.
47+
For a while the plan was to progressively _sunset_ the Classic Notebook and
48+
not maintain it anymore. However, the Classic Notebook is still widely used
49+
and it is still the default user interface for Jupyter in many scenarios.
50+
Many users and organizations have not been able to switch to JupyterLab yet.
51+
For some users, JupyterLab can also be a more complex environment to use,
52+
especially for beginners.
2153

22-
Following the feedback from the community, it was decided late 2021 to continue developing the Jupyter Notebook application and _sunrise_ it as Notebook 7. Notebook 7 is built on top of JupyterLab components and delivers new features like realtime collaboration, debugger, and theming.
54+
Following the feedback from the community, it was decided late 2021 to
55+
continue developing the Jupyter Notebook application and _sunrise_ it as
56+
Notebook 7.
2357

24-
You can find more details about the changes currently taking place in the Jupyter Ecosystem in the [JEP 79] and [team-compass note].
58+
You can find more details about the changes currently taking place in the
59+
Jupyter Ecosystem in the [JEP 79] and [team-compass note].
2560

2661
## New features in Notebook 7
2762

@@ -44,3 +79,5 @@ migrating/multiple-interfaces.md
4479

4580
[jep 79]: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html
4681
[team-compass note]: https://github.com/jupyter/notebook-team-compass/issues/5#issuecomment-1085254000
82+
[find replacements for those that are not available]: https://jupyter-notebook.readthedocs.io/en/latest/migrating/frontend-extensions.html#jupyterlab-equivalent-extensions-to-the-classic-notebook
83+
[nbclassic]: https://github.com/jupyter/nbclassic

0 commit comments

Comments
 (0)