From acff6cabb6b1e2e1ca6d18734b17838aed8962f7 Mon Sep 17 00:00:00 2001 From: Eric Charles Date: Thu, 16 Feb 2023 14:36:17 +0100 Subject: [PATCH 1/4] docs: add migrate to notebook7 page --- docs/source/index.rst | 1 + docs/source/migrate_to_notebook7.rst | 73 ++++++++++++++++++++++++++++ 2 files changed, 74 insertions(+) create mode 100644 docs/source/migrate_to_notebook7.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 1430a8795a..e87b46012e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -14,3 +14,4 @@ The Jupyter Notebook user-documentation configuration contributor + migrate_to_notebook7 diff --git a/docs/source/migrate_to_notebook7.rst b/docs/source/migrate_to_notebook7.rst new file mode 100644 index 0000000000..cfeed2f3f6 --- /dev/null +++ b/docs/source/migrate_to_notebook7.rst @@ -0,0 +1,73 @@ +.. _htmlnotebook: + +NbClassic and Notebook +====================== + +NbClassic in the Jupyter Ecosystem +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Read more details about the changes currently taking place in the +Jupyter Ecosystem in this `team-compass issue`_. + +Any extension developed for Notebook < 7 or NbClassic will not be +compatible with Notebook 7 and upwards. + +**NbClassic and Notebook 7** + +You can install NbClassic, Notebook 7 and JupyterLab, all three of +which will provide different user interfaces +on the same server. When Notebook 7 is available, the NbClassic UI, will +be served at the ``/nbclassic/tree`` base path rather than the +base path ``/tree`` used otherwise. If you are using Notebook 7 along +with NbClassic, you will also have JupyterLab installed as it is a +dependency of Notebook 7, and these front ends will be available +through the following base paths: JupyterLab at ``/lab``, Notebook 7 at +``/tree``, and NbClassic at ``/nbclassic/tree``. + +**NbClassic and Notebook 6.5.x** + +As NbClassic provides the static assets for Notebook 6.5.x, while +having both installed should cause no issues, the user interface provided +by these two packages will be the same. These UIs will be served by +different back end servers. An NbClassic instance will be at a server with the +``/tree`` path and opening a Notebook 6.5.x instance will open on a +different server with the ``/tree`` path as well, presenting the same +static assets. When starting an instance of JupyterLab you will be able +to access the classic view of Notebook with NbClassic served on the same +server at ``/tree``. + +**NbClassic and Notebook <= 6.4.x** + +When using NbClassic and Notebook <= 6.4.x you can expect that these UIs +will not be only presented at different servers, meaning they will both +be available at their respective server under ``/tree`` but they +may also differ as potential changes to the NbClassic UI will not be +reflected in Notebook versions <= 6.4.x. In this case as well, you would +be able to access the classic view of Notebook with NbClassic served on +the same server, at ``/tree``. + +**NbClassic and JupyterLab 3.x** + +When only JupyterLab 3.x is installed, then NbClassic does not have to be +explicitly installed as JupyterLab 3.x depends on it. They will run on +the same server, and are reachable via ``/tree`` for NbClassic and +``/lab`` for JupyterLab. + +**NbClassic and JupyterLab 4.x** + +When only JupyterLab 4.x is installed, then NbClassic has to be installed +explictly. They will run on the same server, and are reachable via +``/tree`` for NbClassic, and ``/lab`` for JupyterLab. + +**NbClassic Independently** + +When you choose to install only NbClassic via ``pip install nbclassic``, +the classic Notebook UI will be presented at the ``/tree`` path. As the +other frontends are not installed, attempting to access the other paths +will return errors. Note that NbClassic being a Jupyter Server extension, +indicated Jupyter Server will be available. This provides an additional +way to view the NbClassic frontend. You would be able to manually +enable the extension when running an instance of Jupyter Server, +``> jupyter server --ServerApp.jpserver_extensions="nbclassic=True"``, +which will provide the NbClassic frontend at ``/tree`` path when visited. + +.. _team-compass issue: https://github.com/jupyter/notebook-team-compass/issues/5#issuecomment-1085254000 From 0faf652d46bca1f03c050337f3ebed3b1364485a Mon Sep 17 00:00:00 2001 From: Eric Charles Date: Fri, 17 Feb 2023 10:26:21 +0100 Subject: [PATCH 2/4] docs: update migrate_to_notebook7.rst --- docs/source/migrate_to_notebook7.rst | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/docs/source/migrate_to_notebook7.rst b/docs/source/migrate_to_notebook7.rst index cfeed2f3f6..86a005cc8f 100644 --- a/docs/source/migrate_to_notebook7.rst +++ b/docs/source/migrate_to_notebook7.rst @@ -1,16 +1,27 @@ -.. _htmlnotebook: +Migrating to Notebook 7 +======================= -NbClassic and Notebook -====================== - -NbClassic in the Jupyter Ecosystem +Build Jupyter Notebook v7 off of JupyterLab components ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Read more details about the changes currently taking place in the -Jupyter Ecosystem in this `team-compass issue`_. +Jupyter Ecosystem in the `JEP 79`_ and `team-compass note`_. + +Notebook 7 is built on top of JupyterLab components and delivers new features +like realtime collaboration, debugger, theming. + +Compatibility with older versions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Any extension developed for Notebook < 7 or NbClassic will not be compatible with Notebook 7 and upwards. +Some extensions like nbgrader have already been ported. We invite you to +check if the extensions you are using have already been ported. + +Simulaneous usage of different versions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + **NbClassic and Notebook 7** You can install NbClassic, Notebook 7 and JupyterLab, all three of @@ -70,4 +81,5 @@ enable the extension when running an instance of Jupyter Server, ``> jupyter server --ServerApp.jpserver_extensions="nbclassic=True"``, which will provide the NbClassic frontend at ``/tree`` path when visited. -.. _team-compass issue: https://github.com/jupyter/notebook-team-compass/issues/5#issuecomment-1085254000 +.. _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 From 450b600ef338db884bdff915c2c35be3fd538374 Mon Sep 17 00:00:00 2001 From: Eric Charles Date: Fri, 17 Feb 2023 11:19:52 +0100 Subject: [PATCH 3/4] docs: lint migrate_to_notebook7.rst --- docs/source/migrate_to_notebook7.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/migrate_to_notebook7.rst b/docs/source/migrate_to_notebook7.rst index 86a005cc8f..91581f6c06 100644 --- a/docs/source/migrate_to_notebook7.rst +++ b/docs/source/migrate_to_notebook7.rst @@ -2,7 +2,7 @@ Migrating to Notebook 7 ======================= Build Jupyter Notebook v7 off of JupyterLab components -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Read more details about the changes currently taking place in the Jupyter Ecosystem in the `JEP 79`_ and `team-compass note`_. @@ -11,7 +11,7 @@ Notebook 7 is built on top of JupyterLab components and delivers new features like realtime collaboration, debugger, theming. Compatibility with older versions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Any extension developed for Notebook < 7 or NbClassic will not be compatible with Notebook 7 and upwards. @@ -20,7 +20,7 @@ Some extensions like nbgrader have already been ported. We invite you to check if the extensions you are using have already been ported. Simulaneous usage of different versions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **NbClassic and Notebook 7** From b48777699d10d609c5e7b7e8791e07c120bee3d9 Mon Sep 17 00:00:00 2001 From: Eric Charles Date: Fri, 17 Feb 2023 11:30:52 +0100 Subject: [PATCH 4/4] docs: lint migrate_to_notebook7.rst --- docs/source/migrate_to_notebook7.rst | 60 ++++++++++++++-------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/source/migrate_to_notebook7.rst b/docs/source/migrate_to_notebook7.rst index 91581f6c06..dd03929266 100644 --- a/docs/source/migrate_to_notebook7.rst +++ b/docs/source/migrate_to_notebook7.rst @@ -16,7 +16,7 @@ Compatibility with older versions Any extension developed for Notebook < 7 or NbClassic will not be compatible with Notebook 7 and upwards. -Some extensions like nbgrader have already been ported. We invite you to +Some extensions like nbgrader have already been ported. We invite you to check if the extensions you are using have already been ported. Simulaneous usage of different versions @@ -27,11 +27,11 @@ Simulaneous usage of different versions You can install NbClassic, Notebook 7 and JupyterLab, all three of which will provide different user interfaces on the same server. When Notebook 7 is available, the NbClassic UI, will -be served at the ``/nbclassic/tree`` base path rather than the -base path ``/tree`` used otherwise. If you are using Notebook 7 along -with NbClassic, you will also have JupyterLab installed as it is a -dependency of Notebook 7, and these front ends will be available -through the following base paths: JupyterLab at ``/lab``, Notebook 7 at +be served at the ``/nbclassic/tree`` base path rather than the +base path ``/tree`` used otherwise. If you are using Notebook 7 along +with NbClassic, you will also have JupyterLab installed as it is a +dependency of Notebook 7, and these front ends will be available +through the following base paths: JupyterLab at ``/lab``, Notebook 7 at ``/tree``, and NbClassic at ``/nbclassic/tree``. **NbClassic and Notebook 6.5.x** @@ -39,46 +39,46 @@ through the following base paths: JupyterLab at ``/lab``, Notebook 7 at As NbClassic provides the static assets for Notebook 6.5.x, while having both installed should cause no issues, the user interface provided by these two packages will be the same. These UIs will be served by -different back end servers. An NbClassic instance will be at a server with the -``/tree`` path and opening a Notebook 6.5.x instance will open on a -different server with the ``/tree`` path as well, presenting the same -static assets. When starting an instance of JupyterLab you will be able -to access the classic view of Notebook with NbClassic served on the same -server at ``/tree``. +different back end servers. An NbClassic instance will be at a server with the +``/tree`` path and opening a Notebook 6.5.x instance will open on a +different server with the ``/tree`` path as well, presenting the same +static assets. When starting an instance of JupyterLab you will be able +to access the classic view of Notebook with NbClassic served on the same +server at ``/tree``. **NbClassic and Notebook <= 6.4.x** When using NbClassic and Notebook <= 6.4.x you can expect that these UIs -will not be only presented at different servers, meaning they will both -be available at their respective server under ``/tree`` but they -may also differ as potential changes to the NbClassic UI will not be -reflected in Notebook versions <= 6.4.x. In this case as well, you would -be able to access the classic view of Notebook with NbClassic served on +will not be only presented at different servers, meaning they will both +be available at their respective server under ``/tree`` but they +may also differ as potential changes to the NbClassic UI will not be +reflected in Notebook versions <= 6.4.x. In this case as well, you would +be able to access the classic view of Notebook with NbClassic served on the same server, at ``/tree``. **NbClassic and JupyterLab 3.x** -When only JupyterLab 3.x is installed, then NbClassic does not have to be -explicitly installed as JupyterLab 3.x depends on it. They will run on -the same server, and are reachable via ``/tree`` for NbClassic and +When only JupyterLab 3.x is installed, then NbClassic does not have to be +explicitly installed as JupyterLab 3.x depends on it. They will run on +the same server, and are reachable via ``/tree`` for NbClassic and ``/lab`` for JupyterLab. **NbClassic and JupyterLab 4.x** -When only JupyterLab 4.x is installed, then NbClassic has to be installed -explictly. They will run on the same server, and are reachable via +When only JupyterLab 4.x is installed, then NbClassic has to be installed +explictly. They will run on the same server, and are reachable via ``/tree`` for NbClassic, and ``/lab`` for JupyterLab. **NbClassic Independently** -When you choose to install only NbClassic via ``pip install nbclassic``, -the classic Notebook UI will be presented at the ``/tree`` path. As the -other frontends are not installed, attempting to access the other paths -will return errors. Note that NbClassic being a Jupyter Server extension, -indicated Jupyter Server will be available. This provides an additional -way to view the NbClassic frontend. You would be able to manually -enable the extension when running an instance of Jupyter Server, -``> jupyter server --ServerApp.jpserver_extensions="nbclassic=True"``, +When you choose to install only NbClassic via ``pip install nbclassic``, +the classic Notebook UI will be presented at the ``/tree`` path. As the +other frontends are not installed, attempting to access the other paths +will return errors. Note that NbClassic being a Jupyter Server extension, +indicated Jupyter Server will be available. This provides an additional +way to view the NbClassic frontend. You would be able to manually +enable the extension when running an instance of Jupyter Server, +``> jupyter server --ServerApp.jpserver_extensions="nbclassic=True"``, which will provide the NbClassic frontend at ``/tree`` path when visited. .. _JEP 79: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html