Add news banner and log #215

echarles · 2023-02-02T09:11:41Z

Related to #214

This PR add a banner and log message. The user can click on a button to not see the banner anymore (that choice is persisted across session and server restart via the local storage).

nbclassic/templates/page.html

echarles · 2023-02-03T10:32:40Z

@jupyter/notebook-council As this PR introduces a very visible change for the users, I am looking for any feedback/enhancement.

echarles · 2023-02-06T06:36:02Z

Thx @RRosio for the review. Let's leave this open a few more days for any feedback before merging.

isabela-pf

Thanks for giving us a chance to look at this! It looks solid to me.

docs/source/nbclassic.rst

nbclassic/templates/page.html

isabela-pf · 2023-02-07T05:40:28Z

nbclassic/templates/page.html

+      <div style="display: flex">
+        <div>
+          <span class="label label-warning">NEWS</span>
+          If you plan to upgrade to Notebook 7, read <a href="https://nbclassic.readthedocs.io/en/latest/nbclassic_notebook.html" target="_top">https://nbclassic.readthedocs.io/en/latest/nbclassic_to_notebook7.html</a>


Both the links in this line give me 404 errors. I'm guessing this is intentional and these docs aren't being pushed to latest until the release, but I wanted to note it just in case.

Once the RDT website deployed (automatically done on PR merge), the 404 will be fixed.

Before releasing, we will double-check that the link is working fine.

Co-authored-by: Isabela Presedo-Floyd <[email protected]>

echarles · 2023-02-07T06:49:48Z

Thx a lot @isabela-pf. I have merged your suggestions.

ellisonbg · 2023-02-07T07:25:43Z

Question - isn't our plan to deprecate and not support notebook 6 moving forward. Do we have a date as to when notebook 6 will stop being supported? If that is the case, don't we want to phrase this to communicate that to users? The phrasing "if you plan..." suggests that upgrading is entirely optional for users.

ellisonbg · 2023-02-07T07:28:18Z

The JEP on noteobook 7 says "Jupyter Notebook v6 will be maintained with critical security fixes for two years following the release of Jupyter Notebook v7." I think the banner should communicate that to users.

ellisonbg · 2023-02-07T07:29:01Z

I should note though that I think a banner like this is a fine idea and will be helpful for users to understand the plan.

echarles · 2023-02-07T07:32:18Z

isn't our plan to deprecate and not support notebook 6 moving forward.

Yes, that is the plan

Do we have a date as to when notebook 6 will stop being supported?

We had a few discussions in the community meeting related to support policies for Notebook, but nothing has been proposed nor decided to my knowledge and understanding.

If that is the case, don't we want to phrase this to communicate that to users? The phrasing "if you plan..." suggests that upgrading is entirely optional for users.

Well, I think the upgrade is optional indeed. As we don't have a EOL support date, I guess we could say "Notebook 6... will soon be deprecated..."

Please note that this banner will for now be shipped for NbClassic, so we may remove the mention to Notebook 6 to make the message more clear.

Also the primary intent of this banner is to highlight that any custom Notebook extensions will stop working with Notebook 7, instead of focussing on any depreciation or invitation to migrate to Notebook 7.

echarles · 2023-02-07T07:33:40Z

The JEP on noteobook 7 says "Jupyter Notebook v6 will be maintained with critical security fixes for two years following the release of Jupyter Notebook v7." I think the banner should communicate that to users.

Thank you for the pointer. Do you have a content that we could use as text for the banner?

echarles · 2023-02-07T07:35:51Z

BTW since the JEP, Notebook has evolved to NbClassic as a Jupyter Server extension, not sure if that 2 years support also applies to NbClassic.

echarles · 2023-02-07T08:35:23Z

The result of the Notebook community meeting discussions can be read on jupyter/notebook-team-compass#5 (comment)

jupyter/notebook#main: The frontend and backend code for Notebook v7. Published to PyPI as notebook (v7)
jupyter/notebook#6.4.x: The frontend and backend code for Notebook v6.4 as it is now. Not maintained anymore, except for critical security fixes. It is superseded by Notebook v6.5 (see below). Published to PyPI as notebook (v6.4). User can pin pip install notebook==6.4, but for nearly all users, Notebook v6.5 or nbclassic v1 will likely be what they actually want on their machines. Installing Notebook v6.4 (or v6.5) not allow them to run on the same server as Notebook v7.
jupyter/notebook#6.5.x: This branch hosts the last releases of the v6 line, Notebook v6.5. No upcoming 6.6 branch should be created and the 6.5 branch aims to be EOL (End Of Life) in a reasonable timeframe -- likely coincident with the eventual release of Notebook v8. On server side, it is the same code base and structure as the Python Tornado NotebookApp of jupyter/notebook#6.4.x but uses the HTML/CSS/JS it gets from its dependency on nbclassic for its UI (see below). This branch receives bug and security fixes. No new features should be implemented in this branch, and relevant issues and PRs should be directed to jupyter/nbclassic#main. It does not use any Python from jupyter/nbclassic#main and is not a jupyter-server extension. Published to PyPI as notebook (v6.5).
jupyter/nbclassic#main: The Python code for nbclassic is a fork of the jupyter/notebook#6.5.x transformed into a jupyter-server extension. Published to PyPI as nbclassic (v1). This repo also contains the HTML/CSS/JS assets of Notebook 6.x (published in npm under a name TBD, e.g. @jupyter-ui/nbclassic), so if you pip install nbclassic you will get a fully operational notebook (v6-flavor). This becomes the only location for the frontend assets of Notebook v6-flavor.

echarles · 2023-02-07T10:02:26Z

The changes are at the nbclassic template and jupyter server extensions levels. As such, they will not show up in Notebook 6.x distributions, even after a new nbclassic release.

We can thus open other PR on the Notebook branches to add similar features (banner + log), but with different messages and focus if needed.

nbclassic/templates/page.html

docs/source/nbclassic_notebook.rst

Co-authored-by: Afshin Taylor Darian <[email protected]>

echarles · 2023-02-16T13:38:07Z

I have updated this PR based on feedbacks collected here and in #214, and opened https://github.com/jupyter/notebook/pull/6737/files

echarles · 2023-02-17T14:25:03Z

@RRosio jupyter/notebook#6737 is merged and https://jupyter-notebook.readthedocs.io/en/latest/migrate_to_notebook7.html is lie

This PR is good to merge so we can cut a release.

RRosio · 2023-02-17T16:15:45Z

docs/source/nbclassic.rst

@@ -147,6 +84,3 @@ Jupyter Notebook 7.
 **Porting Notebook 6 Extensions**: Work being done in parallel. 
 ou can find a helpful list of classical Notebook extensions and corresponding Jupyterlab extensions
 if available at the `Jupyterlab-contrib website <https://jupyterlab-contrib.github.io/migrate_from_classical.html>`_.
-
-
-.. _JEP #79: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html


Since this link has been removed, maybe the syntax in the first line under NbClassic Timeline can be removed? Or the link can be updated to the previously referenced JEP79 link "Jupyter Enhancement Proposal #79"?

I have added back the link to the JEP 79

echarles · 2023-02-17T16:30:17Z

CI is failing with

    bower xterm.js-fit#*                           EHTTP Status code of 502
    /private/var/folders/24/8k48jl6d249_n_qfxwsl6xvm0000gn/T/pip-build-env-etjzzr96/overlay/lib/python3.7/site-packages/setuptools/command/easy_install.py:147: EasyInstallDeprecationWarning: easy_install command is deprecated. Use build and pip and other standards-based tools.
      EasyInstallDeprecationWarning,

RRosio · 2023-02-17T17:21:33Z

CI is failing with

    bower xterm.js-fit#*                           EHTTP Status code of 502
    /private/var/folders/24/8k48jl6d249_n_qfxwsl6xvm0000gn/T/pip-build-env-etjzzr96/overlay/lib/python3.7/site-packages/setuptools/command/easy_install.py:147: EasyInstallDeprecationWarning: easy_install command is deprecated. Use build and pip and other standards-based tools.
      EasyInstallDeprecationWarning,

I read that pip install -e . is the equivalent of running python setup.py develop and that uses(?) EasyInstall? Could we try running python3 -m pip install --user -e . for the job to avoid this error? Although I didn’t check too far back, the error seems to have begun appearing in action 278 and has been intermittently happening ever since. I did see that the version of setuptools installed for packaging changed to setuptools-67.3.2 wheel-0.38.4 ever since action 278. I just opened a PR for a small link update and the same error appeared in the check_release (link_check) but not the check_release (check_release). It doesn't seem to be related to any changes from this PR specifically, if it sounds good to you @echarles I will merge!

echarles · 2023-02-17T17:22:46Z

I have relaunched the CI and the intermediary 502 returned by unpkg is now fixed.

@RRosio this is good to merge. Thx.

add news banner and log

e63f237

echarles added the enhancement New feature or request label Feb 2, 2023

echarles requested review from RRosio and ericsnekbytes February 2, 2023 09:14

RRosio reviewed Feb 2, 2023

View reviewed changes

nbclassic/templates/page.html Outdated Show resolved Hide resolved

docs: create a nbclassic_notebook page

43e16d1

echarles marked this pull request as ready for review February 3, 2023 10:30

isabela-pf reviewed Feb 7, 2023

View reviewed changes

echarles and others added 2 commits February 7, 2023 07:46

Update docs/source/nbclassic.rst

927f67f

Co-authored-by: Isabela Presedo-Floyd <[email protected]>

Update nbclassic/templates/page.html

a9582e6

Co-authored-by: Isabela Presedo-Floyd <[email protected]>

jtpio reviewed Feb 7, 2023

View reviewed changes

nbclassic/templates/page.html Outdated Show resolved Hide resolved

echarles mentioned this pull request Feb 8, 2023

Notebook Weekly Meeting 2023 jupyter/notebook-team-compass#21

Closed

afshin reviewed Feb 15, 2023

View reviewed changes

docs/source/nbclassic_notebook.rst Outdated Show resolved Hide resolved

afshin reviewed Feb 15, 2023

View reviewed changes

docs/source/nbclassic_notebook.rst Outdated Show resolved Hide resolved

afshin reviewed Feb 15, 2023

View reviewed changes

docs/source/nbclassic_notebook.rst Outdated Show resolved Hide resolved

echarles and others added 4 commits February 16, 2023 13:54

Update docs/source/nbclassic_notebook.rst

39a670c

Co-authored-by: Afshin Taylor Darian <[email protected]>

Update docs/source/nbclassic_notebook.rst

f1fb885

Co-authored-by: Afshin Taylor Darian <[email protected]>

Update docs/source/nbclassic_notebook.rst

3046c9c

Co-authored-by: Afshin Taylor Darian <[email protected]>

update banner and log based on jupyter#214

8cc4691

remove nbclassic_notebook doc, and move it to latest notebook rtd

903dc52

docs: fix link to migration plan

dc1bcea

RRosio reviewed Feb 17, 2023

View reviewed changes

docs: add back link in nbclassic.rst

5b19924

RRosio merged commit 00e3836 into jupyter:main Feb 17, 2023

jtpio mentioned this pull request Feb 23, 2023

Missing icons in the news banner on 0.5.2 #223

Closed

andrii-i mentioned this pull request Apr 14, 2023

Add an option to disable the news / Notebook 7 migration banner #242

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add news banner and log #215

Add news banner and log #215

echarles commented Feb 2, 2023 •

edited

Loading

echarles commented Feb 3, 2023

echarles commented Feb 6, 2023

isabela-pf left a comment

isabela-pf Feb 7, 2023

echarles Feb 7, 2023

echarles commented Feb 7, 2023

ellisonbg commented Feb 7, 2023

ellisonbg commented Feb 7, 2023

ellisonbg commented Feb 7, 2023

echarles commented Feb 7, 2023

echarles commented Feb 7, 2023

echarles commented Feb 7, 2023

echarles commented Feb 7, 2023

echarles commented Feb 7, 2023 •

edited

Loading

echarles commented Feb 16, 2023

echarles commented Feb 17, 2023

RRosio Feb 17, 2023

echarles Feb 17, 2023

echarles commented Feb 17, 2023 •

edited

Loading

RRosio commented Feb 17, 2023

echarles commented Feb 17, 2023

Add news banner and log #215

Add news banner and log #215

Conversation

echarles commented Feb 2, 2023 • edited Loading

echarles commented Feb 3, 2023

echarles commented Feb 6, 2023

isabela-pf left a comment

Choose a reason for hiding this comment

isabela-pf Feb 7, 2023

Choose a reason for hiding this comment

echarles Feb 7, 2023

Choose a reason for hiding this comment

echarles commented Feb 7, 2023

ellisonbg commented Feb 7, 2023

ellisonbg commented Feb 7, 2023

ellisonbg commented Feb 7, 2023

echarles commented Feb 7, 2023

echarles commented Feb 7, 2023

echarles commented Feb 7, 2023

echarles commented Feb 7, 2023

echarles commented Feb 7, 2023 • edited Loading

echarles commented Feb 16, 2023

echarles commented Feb 17, 2023

RRosio Feb 17, 2023

Choose a reason for hiding this comment

echarles Feb 17, 2023

Choose a reason for hiding this comment

echarles commented Feb 17, 2023 • edited Loading

RRosio commented Feb 17, 2023

echarles commented Feb 17, 2023

echarles commented Feb 2, 2023 •

edited

Loading

echarles commented Feb 7, 2023 •

edited

Loading

echarles commented Feb 17, 2023 •

edited

Loading