diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 79f86a1c61..d9e70611ba 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,8 @@ -______________________________________________________________________ - -## name: "\\U0001F41B Bug report" about: Create a report to help us repair something that is currently broken labels: bug, status:Needs Triage +--- +name: "\U0001F41B Bug report" +about: Create a report to help us repair something that is currently broken +labels: bug, status:Needs Triage +--- @@ -33,9 +35,9 @@ Here, we're looking for specific bugs in the Jupyter Notebook codebase. If you t 1. Go to '...' -1. Click on '...' -1. Scroll down to '...' -1. See error '...' +2. Click on '...' +3. Scroll down to '...' +4. See error '...' @@ -50,9 +52,7 @@ https://jupyter-notebook.readthedocs.io/en/latest/troubleshooting.html --> - Operating System and version: - Browser and version: - - - Jupyter Notebook version: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 74642eae3e..4904f7223d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,6 +1,8 @@ -______________________________________________________________________ - -## name: "\\U0001F680 Feature Request" about: Suggest a new feature or a change labels: enhancement, status:Needs Triage +--- +name: "\U0001F680 Feature Request" +about: Suggest a new feature or a change +labels: enhancement, status:Needs Triage +--- diff --git a/docs/source/migrate_to_notebook7.md b/docs/source/migrate_to_notebook7.md index 33a762ac98..91c6c1ef81 100644 --- a/docs/source/migrate_to_notebook7.md +++ b/docs/source/migrate_to_notebook7.md @@ -77,7 +77,7 @@ migrating/custom-themes.md migrating/multiple-interfaces.md ``` -[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 [jep 79]: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html -[nbclassic]: https://github.com/jupyter/nbclassic [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 diff --git a/docs/source/migrating/frontend-extensions.md b/docs/source/migrating/frontend-extensions.md index c9eaeaee8e..ecd0ee4cea 100644 --- a/docs/source/migrating/frontend-extensions.md +++ b/docs/source/migrating/frontend-extensions.md @@ -14,11 +14,14 @@ You can check the following resources to see if your extension is available for To get an idea of the extensions available for Notebook 7, you can check the following resources: -- [List of JupyterLab extensions] -- [Awesome Jupyter] +- [List of JupyterLab extensions][list of jupyterlab extensions] +- [Awesome Jupyter][awesome jupyter] These resources are for JupyterLab, but many of them are compatible with Notebook 7 since Notebook 7 is based on JupyterLab. +[list of jupyterlab extensions]: https://jupyterlab-contrib.github.io/extensions.html +[awesome jupyter]: https://github.com/markusschanta/awesome-jupyter#jupyterlab-extensions + ## JupyterLab equivalent extensions to the Classic Notebook The `jupyterlab-contrib` organization maintains a list of extensions to ease the transition from the Classic Notebook to Notebook 7 and / or JupyterLab. @@ -27,6 +30,4 @@ The list is available at the following URL: [Migrating from the Classic Notebook ![a screenshot showing extensions in classic and lab](https://user-images.githubusercontent.com/591645/229616855-94d34762-6666-4edd-a969-e85b285d7094.png) -[awesome jupyter]: https://github.com/markusschanta/awesome-jupyter#jupyterlab-extensions -[list of jupyterlab extensions]: https://jupyterlab-contrib.github.io/extensions.html [migrate from classic]: https://jupyterlab-contrib.github.io/migrate_from_classical.html diff --git a/docs/source/migrating/multiple-interfaces.md b/docs/source/migrating/multiple-interfaces.md index 649ac465a2..2d8fcdd298 100644 --- a/docs/source/migrating/multiple-interfaces.md +++ b/docs/source/migrating/multiple-interfaces.md @@ -13,6 +13,8 @@ You can try JupyterLab, Notebook 7 and NBClassic installed together using [this [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gist/jtpio/35a72862c8be13dee31b61ebac2d9786/master?urlpath=/tree) +[lab-nb-nbclassic]: https://gist.github.com/jtpio/35a72862c8be13dee31b61ebac2d9786 + ## Using the `Interface` dropdown Notebook 7 provides a dropdown menu to switch between the different user interfaces available on the same server. @@ -84,5 +86,3 @@ 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. - -[lab-nb-nbclassic]: https://gist.github.com/jtpio/35a72862c8be13dee31b61ebac2d9786 diff --git a/docs/source/notebook.md b/docs/source/notebook.md index fb046e2e30..1eab1b8fa1 100644 --- a/docs/source/notebook.md +++ b/docs/source/notebook.md @@ -37,8 +37,8 @@ notebook and its dependencies. computations attached to the code which generated them. - Displaying the result of computation using rich media representations, such as HTML, LaTeX, PNG, SVG, etc. For example, publication-quality figures - rendered by the \[matplotlib\] library, can be included inline. -- In-browser editing for rich text using the \[Markdown\] markup language, which + rendered by the [matplotlib] library, can be included inline. +- In-browser editing for rich text using the [Markdown] markup language, which can provide commentary for the code, is not limited to plain text. - The ability to easily include mathematical notation within markdown cells using LaTeX, and rendered natively by [MathJax]. @@ -56,14 +56,14 @@ colleagues. Notebooks may be exported to a range of static formats, including HTML (for example, for blog posts), reStructuredText, LaTeX, PDF, and slide shows, via -the \[nbconvert\] command. +the [nbconvert] command. Furthermore, any `.ipynb` notebook document available from a public URL can be shared via the Jupyter Notebook Viewer \. This service loads the notebook document from the URL and renders it as a static web page. The results may thus be shared with a colleague, or as a public blog post, without other users needing to install the Jupyter notebook -themselves. In effect, nbviewer is simply \[nbconvert\] as +themselves. In effect, nbviewer is simply [nbconvert] as a web service, so you can do your own static conversions with nbconvert, without relying on nbviewer. @@ -278,7 +278,7 @@ the IPython session. _Raw_ cells provide a place in which you can write _output_ directly. Raw cells are not evaluated by the notebook. -When passed through \[nbconvert\], raw cells arrive in the +When passed through [nbconvert], raw cells arrive in the destination format unmodified. For example, you can type full LaTeX into a raw cell, which will only be rendered by LaTeX after conversion by nbconvert. @@ -349,7 +349,7 @@ document content to the browser at the expense of performance. One major feature of the Jupyter notebook is the ability to display plots that are the output of running code cells. The IPython kernel is designed to work -seamlessly with the \[matplotlib\] plotting library to provide this functionality. +seamlessly with the [matplotlib] plotting library to provide this functionality. Specific plotting library integration is a feature of the kernel. ## Installing kernels diff --git a/docs/source/notebook_7_features.md b/docs/source/notebook_7_features.md index ad2aad6344..c51697b20c 100644 --- a/docs/source/notebook_7_features.md +++ b/docs/source/notebook_7_features.md @@ -1,6 +1,6 @@ # New features in Notebook 7 -This document describes the new features in Notebook 7 as originally mentioned in the related Jupyter Enhancement Proposal [JEP 79]. +This document describes the new features in Notebook 7 as originally mentioned in the related Jupyter Enhancement Proposal [JEP 79][jep 79]. ```{contents} Table of Contents :depth: 3 @@ -124,10 +124,12 @@ pip install jupyterlab-rise ## A document-centric user experience -Despite all the new features and as stated in [JEP 79], Notebook 7 keeps the document-centric user experience of the Classic Notebook: +Despite all the new features and as stated in [JEP 79][jep 79], Notebook 7 keeps the document-centric user experience of the Classic Notebook: > The Jupyter Notebook application offers a document-centric user experience. That is, in the Notebook application, the landing page that contains a file manager, running tools tab, and a few optional extras, is a launching point into opening standalone, individual documents. This document-centric experience is important for many users, and that is the first key point this proposal aims to preserve. Notebook v7 will be based on a different JavaScript implementation than v6, but it will preserve the document-centric experience, where each individual notebook opens in a separate browser tab and the visible tools and menus are focused on the open document. +[jep 79]: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html + ## Compact View on Mobile Devices Notebook 7 automatically switches to a more compact layout on mobile devices, making it convenient to run code on the go. @@ -140,5 +142,3 @@ This was just a quick overview of the new features in Notebook 7. For more detai - The [JupyterLab Documentation](https://jupyterlab.readthedocs.io/en/latest/) is a great resource to learn more about JupyterLab and the extensions available. Since Notebook 7 is based on JupyterLab, many of the features and extensions available for JupyterLab are also available for Notebook 7. - [Migration Guide](./migrate_to_notebook7.md) for Notebook 7, which explains how to migrate from the Classic Notebook to Notebook 7. - -[jep 79]: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html