Updating documentation for nbclassic

CONTRIBUTING.rst

@@ -43,7 +43,7 @@ You can also use the installer from the `Node.js website <https://nodejs.org>`_.
 
 
 Installing the Jupyter NbClassic
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Once you have installed the dependencies mentioned above, use the following
 steps::
@@ -71,7 +71,7 @@ If you are working in development mode, you will see that your version of Jupyte
 Troubleshooting the Installation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-If you do not see that your Jupyter NbClassic is not running on dev mode, it's possible that you are
+If you do not see that your Jupyter NbClassic is running on dev mode, it's possible that you are
 running other instances of Jupyter NbClassic. You can try the following steps:
 
 1. Uninstall all instances of the NbClassic package. These include any installations you made using

docs/source/conf.py

@@ -93,7 +93,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'Jupyter Notebook'
+project = 'NbClassic'
 copyright = '2015, Jupyter Team, https://jupyter.org'
 author = 'The Jupyter Team'
 

docs/source/index.rst

@@ -1,6 +1,6 @@
-====================
-The Jupyter Notebook
-====================
+===================================
+The Jupyter Notebook with NbClassic
+===================================
 
 * `Installation <https://jupyter.readthedocs.io/en/latest/install.html>`_
 * `Starting the Notebook <https://jupyter.readthedocs.io/en/latest/running.html>`_
@@ -9,6 +9,7 @@ The Jupyter Notebook
    :maxdepth: 1
    :caption: User Documentation
 
+   nbclassic
    notebook
    ui_components
    examples/Notebook/examples_index.rst
@@ -33,6 +34,7 @@ The Jupyter Notebook
    :caption: Contributor Documentation
 
    contributing
+   nbclassic_dev_faq
    development_faq
 
 .. toctree::

docs/source/nbclassic.rst

@@ -0,0 +1,84 @@
+.. _htmlnotebook:
+
+Jupyter NbClassic
+====================
+
+Introduction
+------------
+
+The nbclassic package is the implementation of the classic Jupyter
+Notebook-v6 as a Jupyter Server extension. As proposed in the accepted
+`Jupyter Enhancement Proposal #79`_ the development of this package
+is due to plans being carried out to create a Notebook-v7, that is based on
+the modern JupyterLab code-base. 
+
+While Notebook-v7 provides a user experience equivalent to that of the
+classic Notebook-v6, the technology stack used is incompatible with
+that which many Jupyter Notebook users have developed their Jupyter
+Notebook extensions with. Users may find themselves in need of a
+way to continue using the Jupyter Notebook-v6 tech-stack as they
+transition to using the Jupyter Notebook-v7. The NbClassic package
+intends to address that need.
+
+.. _Jupyter Enhancement Proposal #79: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html
+
+
+NbClassic Usage
+---------------
+
+Installation
+~~~~~~~~~~~~
+
+Installing from PyPI:
+``> pip install nbclassic``
+This will automatically enable the extension in Jupyter Server.
+
+Launch directly:
+``> jupyter nbclassic``
+
+Alternatively, you can run Jupyter Server and visit the `/tree` endpoint:
+``> jupyter server``
+
+
+NbClassic in the Jupyter Ecosystem
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can install the nbclassic, notebook-v7 and jupyterlab, all three of
+which will be providing different user interfaces that will be available
+on the same server.
+
+As nbclassic provides the static assets for notebook-v6.5.x, while
+having both installed should cause no issues, the user interface provided
+by these two packages will be the same. These UIs would be available in
+different servers.
+
+When using nbclassic and notebook <= v6.4.x you can expect that these UIs
+will not be only presented at different servers but may also differ as
+potential changes to the nblcassic UI will not be reflected in Notebook
+versions <= 6.4.x.
+
+
+NbClassic Development
+---------------------
+
+Nbclassic is the package that holds the UI components of
+the classic Jupyter Notebook-v6 and serves this UI through the server
+endpoints provided by Jupyter Server.
+
+**The jupyter/notebook Repository**: The original `jupyter/notebook`_` GitHub 
+repository now holds the codebase for the new Jupyter Notebook (version 7).
+
+.. _jupyter/notebook: https://github.com/jupyter/notebook
+
+
+NbClassic Timeline
+------------------
+As proposed in the `JEP #79`_, the nbclassic
+package will continue to be supported with critical security fixes
+in the transition period as users move to using the more modern 
+Jupyter Notebook-v7.
+
+**Porting Notebook-v6 Extensions**: Work being done in parallel.
+
+
+.. _JEP #79: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html

docs/source/nbclassic_dev_faq.rst

@@ -0,0 +1,6 @@
+.. _nbclassic_dev_faq:
+
+Developer FAQ
+=============
+
+1. Where should I submit my issue?