From d22d6f79341e7ca1c66dba733d9d2a46bd9eae25 Mon Sep 17 00:00:00 2001 From: Eric Gentry Date: Mon, 24 Apr 2023 10:36:00 -0400 Subject: [PATCH 1/7] Added extra information and user-action summaries to 7 migration docs. --- docs/source/migrate_to_notebook7.md | 65 ++++++++++++++++++++++------- 1 file changed, 51 insertions(+), 14 deletions(-) diff --git a/docs/source/migrate_to_notebook7.md b/docs/source/migrate_to_notebook7.md index ee867b2689..558911387d 100644 --- a/docs/source/migrate_to_notebook7.md +++ b/docs/source/migrate_to_notebook7.md @@ -1,27 +1,62 @@ # Migrating to Notebook 7 -```{warning} -The Jupyter Notebook application is undergoing a major refactoring to -improve the user experience and to make it easier to maintain and extend. +*Updated 2023-04-24* -This set of migration guides are intended to help you migrate your Classic Notebook -setup and extensions to the new Jupyter Notebook 7, which is built on top of JupyterLab 4. +```{warning} +The Jupyter Notebook application's newest version 7 upgrade might break your +extensions or other customizations, please read more below to find out if you +need to take any actions to ensure a smooth, uninterrupted experience ``` -## Sunrising the Jupyter Notebook 7 +A major upgrade to the Jupyter Notebook app is coming with Notebook 7! This +upgrade will bring a heap of new features, but will also break backwards +compatibility with many classic Notebook features and customizations. + +This set of guides is here to help you migrate your Classic Notebook setup and +extensions to the new Notebook 7. + +## What you need to do + +For users who don't use extensions or other customizations, you will seamlessly +receive the new Notebook 7 when you `pip install notebook` once version 7 is +released out of beta, along with all its new features, like realtime +collaboration, debugger, and theming. + +For users who need to use extensions or other customizations, you have a couple +of options: + +- Look for Notebook 7 compatible versions of the extensions you already use, + and [find replacements for those that are not available] + +- If you NEED to maintain compatibility with the Classic Notebook for extensions + or other customizations that are critical to your workflows, you can switch to + [nbclassic], the new home for users who need to maintain compatibility with the + old notebook interface + +## Why things are changing -For the past few years, the Classic Jupyter Notebook has been in maintenance mode. +For the past few years, the Classic Jupyter Notebook has been in maintenance +mode. -Development has mostly moved to alternative user interfaces like JupyterLab, which is a more -modern and extensible web application. This has resulted in a lot of new -features and improvements in JupyterLab, but also in a lot of new features and -improvements that were not possible to integrate to the Classic Notebook. +Development has mostly moved to alternative user interfaces like JupyterLab, +which is a more modern and extensible web application. This has resulted in +a lot of new features and improvements in JupyterLab, but also in a lot of +new features and improvements that were not possible to integrate to the +Classic Notebook. -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. +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. -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. +Following the feedback from the community, it was decided late 2021 to +continue developing the Jupyter Notebook application and _sunrise_ it as +Notebook 7. -You can find more details about the changes currently taking place in the Jupyter Ecosystem in the [JEP 79] and [team-compass note]. +You can find more details about the changes currently taking place in the +Jupyter Ecosystem in the [JEP 79] and [team-compass note]. ## New features in Notebook 7 @@ -44,3 +79,5 @@ migrating/multiple-interfaces.md [jep 79]: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html [team-compass note]: https://github.com/jupyter/notebook-team-compass/issues/5#issuecomment-1085254000 +[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 +[nbclassic]: https://github.com/jupyter/nbclassic From 8bd3da1c9a29951173c265551f5d174ef04bb16d Mon Sep 17 00:00:00 2001 From: Eric Gentry Date: Tue, 25 Apr 2023 08:37:43 -0400 Subject: [PATCH 2/7] Update docs/source/migrate_to_notebook7.md Co-authored-by: Jeremy Tuloup --- docs/source/migrate_to_notebook7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/migrate_to_notebook7.md b/docs/source/migrate_to_notebook7.md index 558911387d..fcae41a192 100644 --- a/docs/source/migrate_to_notebook7.md +++ b/docs/source/migrate_to_notebook7.md @@ -8,7 +8,7 @@ extensions or other customizations, please read more below to find out if you need to take any actions to ensure a smooth, uninterrupted experience ``` -A major upgrade to the Jupyter Notebook app is coming with Notebook 7! This +A major upgrade to the Jupyter Notebook interface is coming with Notebook 7! This upgrade will bring a heap of new features, but will also break backwards compatibility with many classic Notebook features and customizations. From 33449919773073b3ca2038df0e3b55e8e770480a Mon Sep 17 00:00:00 2001 From: Eric Gentry Date: Tue, 25 Apr 2023 08:37:54 -0400 Subject: [PATCH 3/7] Update docs/source/migrate_to_notebook7.md Co-authored-by: Jeremy Tuloup --- docs/source/migrate_to_notebook7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/migrate_to_notebook7.md b/docs/source/migrate_to_notebook7.md index fcae41a192..a123051469 100644 --- a/docs/source/migrate_to_notebook7.md +++ b/docs/source/migrate_to_notebook7.md @@ -28,7 +28,7 @@ of options: - Look for Notebook 7 compatible versions of the extensions you already use, and [find replacements for those that are not available] -- If you NEED to maintain compatibility with the Classic Notebook for extensions +- If you need to maintain compatibility with the Classic Notebook for extensions or other customizations that are critical to your workflows, you can switch to [nbclassic], the new home for users who need to maintain compatibility with the old notebook interface From de8e18aeb80575734dfdbcfc0577fce6486560d6 Mon Sep 17 00:00:00 2001 From: Eric Gentry Date: Tue, 25 Apr 2023 09:44:32 -0400 Subject: [PATCH 4/7] Updated nbclassic messaging. --- docs/source/migrate_to_notebook7.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/migrate_to_notebook7.md b/docs/source/migrate_to_notebook7.md index a123051469..65762017fd 100644 --- a/docs/source/migrate_to_notebook7.md +++ b/docs/source/migrate_to_notebook7.md @@ -30,8 +30,8 @@ of options: - If you need to maintain compatibility with the Classic Notebook for extensions or other customizations that are critical to your workflows, you can switch to - [nbclassic], the new home for users who need to maintain compatibility with the - old notebook interface + [nbclassic], which will provide compatibility with the old notebook interface + and support during an intermediate transition period to Notebook 7 ## Why things are changing From 36ab2ab77d4fdf199e2bc68fade452395aa19158 Mon Sep 17 00:00:00 2001 From: Eric Gentry Date: Wed, 26 Apr 2023 12:28:41 -0400 Subject: [PATCH 5/7] Revised heading. --- docs/source/migrate_to_notebook7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/migrate_to_notebook7.md b/docs/source/migrate_to_notebook7.md index 65762017fd..7bc23ad3fb 100644 --- a/docs/source/migrate_to_notebook7.md +++ b/docs/source/migrate_to_notebook7.md @@ -33,7 +33,7 @@ of options: [nbclassic], which will provide compatibility with the old notebook interface and support during an intermediate transition period to Notebook 7 -## Why things are changing +## Why the big version change? For the past few years, the Classic Jupyter Notebook has been in maintenance mode. From ade558893a39d082e46ae3630c067d600e8f1a66 Mon Sep 17 00:00:00 2001 From: Eric Gentry Date: Thu, 27 Apr 2023 09:27:55 -0400 Subject: [PATCH 6/7] Updated heading. --- docs/source/migrate_to_notebook7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/migrate_to_notebook7.md b/docs/source/migrate_to_notebook7.md index 7bc23ad3fb..9e7e51cb3e 100644 --- a/docs/source/migrate_to_notebook7.md +++ b/docs/source/migrate_to_notebook7.md @@ -33,7 +33,7 @@ of options: [nbclassic], which will provide compatibility with the old notebook interface and support during an intermediate transition period to Notebook 7 -## Why the big version change? +## Why a new version? For the past few years, the Classic Jupyter Notebook has been in maintenance mode. From 0fa3626c5676458bc3b7ce7e4f2ba83ec7a66652 Mon Sep 17 00:00:00 2001 From: Eric Gentry Date: Thu, 27 Apr 2023 14:07:35 -0400 Subject: [PATCH 7/7] Formatting pass. --- docs/source/migrate_to_notebook7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/migrate_to_notebook7.md b/docs/source/migrate_to_notebook7.md index 9e7e51cb3e..9a606d7ab9 100644 --- a/docs/source/migrate_to_notebook7.md +++ b/docs/source/migrate_to_notebook7.md @@ -1,6 +1,6 @@ # Migrating to Notebook 7 -*Updated 2023-04-24* +_Updated 2023-04-24_ ```{warning} The Jupyter Notebook application's newest version 7 upgrade might break your