Merge pull request #781 from raybellwaves/patch-8

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

View File

@@ -113,7 +113,8 @@ Installing TLJH plugins
The Littlest JupyterHub can install additional *plugins* that provide additional The Littlest JupyterHub can install additional *plugins* that provide additional
features. They are most commonly used to install a particular *stack* - such as 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 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 ``--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, 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`` ``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. 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, For example, to install the PANGEO Plugin version 0.1 (if version 0.1 existed)
you would use: in your new TLJH install, you would use:
.. code-block:: bash .. 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>``. 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:: .. note::
Plugins are extremely powerful and can do a large number of arbitrary things. Plugins are extremely powerful and can do a large number of arbitrary things.