Browse Source

Add JupyterHub note to installation and clean up change log

Steven Silvester 5 years ago
parent
commit
7e308c4e9a

+ 4 - 2
docs/source/getting_started/changelog.rst

@@ -38,7 +38,8 @@ User-facing changes
 
 For developers
 ^^^^^^^^^^^^^^
-Backward incompatible changes:
+Backward incompatible changes
+-----------------------------
 * Switch from ``@phosphor`` to ``@lumino`` dependencies. (`#7582 <https://github.com/jupyterlab/jupyterlab/pull/7582>`__, `#7534 <https://github.com/jupyterlab/jupyterlab/issues/7534>`__)
 * Factor out the ``settingsregistry`` and ``statedb`` packages from coreutils (`#7681 <https://github.com/jupyterlab/jupyterlab/pull/7681>`__, `#7615 <https://github.com/jupyterlab/jupyterlab/issues/7615>`__)
 * Rework services architecture (sessions, kernels, terminals).  Rename ``ClientSession`` to ``SessionContext`` (`#7252 <https://github.com/jupyterlab/jupyterlab/pull/7252>`__, `#7674 <https://github.com/jupyterlab/jupyterlab/pull/7674>`__)
@@ -46,7 +47,8 @@ Backward incompatible changes:
 * Remove ``polling`` from coreutils in favor for ``@lumino/polling`` (`#7617 <https://github.com/jupyterlab/jupyterlab/pull/7617>`__)
 * TypeScript strict null checking in core packages (`#7657 <https://github.com/jupyterlab/jupyterlab/pull/7657>`__, `#7607 <https://github.com/jupyterlab/jupyterlab/pull/7607>`__)
 
-Other changes:
+Other changes
+-------------
 * New property inspector used to display the properties of the currently selected main area widget (`#7665 <https://github.com/jupyterlab/jupyterlab/pull/7665>`__, `#7664 <https://github.com/jupyterlab/jupyterlab/issues/7664>`__, `#7718 <https://github.com/jupyterlab/jupyterlab/pull/7718>`__, `#7686 <https://github.com/jupyterlab/jupyterlab/issues/7686>`__)
 * Allow metadata for launcher items (`#7654 <https://github.com/jupyterlab/jupyterlab/pull/7654>`__, `#7652 <https://github.com/jupyterlab/jupyterlab/issues/7652>`__)
 * Enable platform-aware key shortcuts (`#7589 <https://github.com/jupyterlab/jupyterlab/pull/7589>`__)

+ 14 - 0
docs/source/getting_started/installation.rst

@@ -85,6 +85,17 @@ the version of the ``notebook`` package that you have installed:
 
     jupyter notebook --version
 
+
+Usage with JupyterHub
+~~~~~~~~~~~~~~~~~~~~~
+
+Install JupyterLab and JupyterHub.
+
+In ``jupyterhub_config.py``, configure the ``Spawner`` to tell the single-user notebook servers to default to JupyterLab:
+
+``c.Spawner.default_url = '/lab'``
+
+
 Supported browsers
 ~~~~~~~~~~~~~~~~~~
 
@@ -101,3 +112,6 @@ minimum versions listed above.  IE 11+ or Edge 14 do not support
 CSS Variables, and are not directly supported at this time.
 A tool like `postcss <https://postcss.org/>`__ can be used to convert the CSS files in the
 ``jupyterlab/build`` directory manually if desired.
+
+
+