zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #781 from raybellwaves/patch-8

Browse Source 
DOC: move link to contributing/plugin higher
This commit is contained in:
Georgiana Elena
2022-01-27 13:44:57 +02:00
committed by GitHub
parent 63ad897ea8 952b775e85
commit 0572976d25
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/topic/customizing-installer.rst
View File

@@ -113,7 +113,8 @@ Installing TLJH plugins
The Littlest JupyterHub can install additional *plugins* that provide additional
features. They are most commonly used to install a particular *stack* - such as
the `PANGEO Stack <https://github.com/yuvipanda/tljh-pangeo>`_ for earth sciences
research, a stack for a particular class, etc.
research, a stack for a particular class, etc. You can find more information about
writing plugins and a list of existing plugins at :ref:`contributing/plugins`.
``--plugin <plugin-to-install>`` installs and activates a plugin. You can pass it
however many times you want. Since plugins are distributed as python packages,
@@ -121,8 +122,8 @@ however many times you want. Since plugins are distributed as python packages,
``plugin-name-on-pypi==<version>`` and ``git+https://github.com/user/repo@tag``
are the most popular ones. Specifying a version or tag is highly recommended.
For example, to install the PANGEO Plugin version 0.1 in your new TLJH install,
you would use:
For example, to install the PANGEO Plugin version 0.1 (if version 0.1 existed)
in your new TLJH install, you would use:
.. code-block:: bash
@@ -133,8 +134,6 @@ you would use:
Multiple plugins can be installed at once with: ``--plugin <first-plugin-to-install> <second-plugin-to-install>``.
See :ref:`contributing/plugins` for more information about plugins.
.. note::
Plugins are extremely powerful and can do a large number of arbitrary things.