Skip to content

Commit a24a58f

Browse files
committed
update documentation with info for simultaneous use of lab, notebook and nbclassic
1 parent c46151b commit a24a58f

File tree

2 files changed

+31
-9
lines changed

2 files changed

+31
-9
lines changed

docs/source/nbclassic.rst

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,19 +60,37 @@ NbClassic in the Jupyter Ecosystem
6060
Read more details about the changes currently taking place in the
6161
Jupyter Ecosystem in this `team-compass issue`_.
6262

63-
You can install the nbclassic, notebook 7 and jupyterlab, all three of
63+
**NbClassic and Notebook 7**
64+
65+
You can install NbClassic, Notebook 7 and JupyterLab, all three of
6466
which will be providing different user interfaces that will be available
65-
on the same server.
67+
on the same server. When Notebook 7 is available, the NbClassic UI, will
68+
be served at the ``/nbclassic/tree`` base URL rather than the
69+
base URL ``/tree`` used otherwise. If you are using Notebook 7 along
70+
with NbClassic, you wil also have JupyterLab installed as it is a
71+
dependency of Notebook 7, and these front ends will be available
72+
through the following base URLs: JupyterLab at ``/lab``, Notebook 7 at
73+
``/tree``, and NbClassic at ``/nbclassic/tree``.
74+
75+
**NbClassic and Notebook 6**
6676

67-
As nbclassic provides the static assets for notebook 6.5.x, while
77+
As NbClassic provides the static assets for Notebook 6.5.x, while
6878
having both installed should cause no issues, the user interface provided
6979
by these two packages will be the same. These UIs would be available in
70-
different servers.
71-
72-
When using nbclassic and notebook <= 6.4.x you can expect that these UIs
73-
will not be only presented at different servers but may also differ as
74-
potential changes to the nbclassic UI will not be reflected in Notebook
75-
versions <= 6.4.x.
80+
different servers. An NbClassic instance will be at a server with the
81+
``/tree`` URL and opening a Notebook 6.5.x instance will open on a
82+
different server with the ``/tree`` URL as well, presenting the same
83+
static assets. When starting an instance of JupyterLab you will be able
84+
to access the classic view of Notebook with NbClassic served on the same
85+
server at the ``/tree`` URL.
86+
87+
When using NbClassic and Notebook <= 6.4.x you can expect that these UIs
88+
will not be only presented at different servers, meaning they will both
89+
be available at their respective server under the ``/tree`` URL but they
90+
may also differ as potential changes to the NbClassic UI will not be
91+
reflected in Notebook versions <= 6.4.x. In this case as well, you would
92+
be able to access the classic view of Notebook with NbClassic served on
93+
the same server, at the ``/tree`` URL.
7694

7795
.. _team-compass issue: https://github.com/jupyter/notebook-team-compass/issues/5#issuecomment-1085254000
7896

docs/source/nbclassic_dev_faq.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,12 @@ Noteworthy Updates in NbClassic
2525

2626
- Endpoints in NbClassic
2727
- NbClassic handlers have been updated to account for Notebook 7 being installed (`Handlers under nbclassic if notebook 7 is found`_). If so, the resources from nbclassic will be served under the ``/nbclassic/`` URL subpath, so as to not interfere with those resources being served by Jupyter Notebook.
28+
- Redirecting from ``/tree`` to ``/nbclassic/tree`` if both Notebook 7 and NbClassic are installed (`PR #166`_).
2829

2930
.. _`Handlers under nbclassic if notebook 7 is found`: https://github.com/jupyter/nbclassic/pull/141
31+
.. _`PR #166`: https://github.com/jupyter/nbclassic/pull/166
32+
33+
3034

3135
NbClassic Developer FAQ
3236
-----------------------

0 commit comments

Comments
 (0)