Skip to content

Commit de6d904

Browse files
docs: list server extensions (#1412)
1 parent be994d2 commit de6d904

File tree

6 files changed

+43
-9
lines changed

6 files changed

+43
-9
lines changed

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
author = "The Jupyter Team"
7171

7272
# ghissue config
73-
github_project_url = "https://github.com/jupyter/jupyter_server"
73+
github_project_url = "https://github.com/jupyter-server/jupyter_server"
7474

7575
# The version info for the project you're documenting, acts as replacement for
7676
# |version| and |release|, also used in various other places throughout the

docs/source/contributors/team-meetings.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Also check out Jupyter Server's roadmap where we track future plans for Jupyter
2323

2424
`Jupyter Server 2.0 Discussion <https://github.com/jupyter-server/team-compass/issues/24>`_
2525

26-
`Archived roadmap <https://github.com/jupyter/jupyter_server/issues/127>`_
26+
`Archived roadmap <https://github.com/jupyter-server/jupyter_server/issues/127>`_
2727

2828
Jupyter Calendar
2929
----------------

docs/source/developers/extensions.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ Server Extensions
66

77
A Jupyter Server extension is typically a module or package that extends to Server’s REST API/endpoints—i.e. adds extra request handlers to Server’s Tornado Web Application.
88

9-
You can check some simple examples on the `examples folder
10-
<https://github.com/jupyter/jupyter_server/tree/main/examples/simple>`_ in the GitHub jupyter_server repository.
9+
For examples of jupyter server extensions, see the
10+
:ref:`homepage <examples of jupyter server extensions>`.
11+
12+
To get started writing your own extension, see the simple examples in the `examples folder
13+
<https://github.com/jupyter-server/jupyter_server/tree/main/examples/simple>`_ in the GitHub jupyter_server repository.
14+
1115

1216
Authoring a basic server extension
1317
==================================

docs/source/index.rst

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@ Welcome!
33

44
You've landed on the documentation pages for the **Jupyter Server** Project. Some other pages you may have been looking for:
55

6-
* `Jupyter Server Github Repo <https://github.com/jupyter/jupyter_server>`_, the source code we describe in this code.
6+
* `Jupyter Server Github Repo <https://github.com/jupyter-server/jupyter_server>`_, the source code we describe in this code.
77
* `Jupyter Notebook Github Repo <https://github.com/jupyter/notebook>`_ , the source code for the classic Notebook.
88
* `JupyterLab Github Repo <https://github.com/jupyterlab/jupyterlab>`_, the JupyterLab server which runs on the Jupyter Server.
99

1010

1111
Introduction
1212
------------
1313

14-
Jupyter Server is the backend—the core services, APIs, and `REST endpoints`_—to Jupyter web applications.
14+
Jupyter Server is the backend that provides the core services, APIs, and
15+
`REST endpoints`_ for Jupyter web applications.
1516

1617
.. note::
1718

@@ -21,6 +22,34 @@ Jupyter Server is the backend—the core services, APIs, and `REST endpoints`_
2122
.. _Jupyter Notebook: https://github.com/jupyter/notebook
2223
.. _REST endpoints: https://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/jupyter_server/main/jupyter_server/services/api/api.yaml
2324

25+
26+
Applications
27+
------------
28+
29+
Jupyter Server extensions can use the framework and services provided by
30+
Jupyter Server to create applications and services.
31+
32+
Examples of Jupyter Server extensions include:
33+
34+
.. _examples of jupyter server extensions:
35+
36+
`Jupyter Lab <https://jupyterlab.readthedocs.io>`_
37+
JupyterLab computational environment.
38+
`Jupyter Resource Usage <https://github.com/jupyter-server/jupyter-resource-usage>`_
39+
Jupyter Notebook Extension for monitoring your own resource usage.
40+
`Jupyter Scheduler <https://jupyter-scheduler.readthedocs.io>`_
41+
Run Jupyter notebooks as jobs.
42+
`jupyter-collaboration <https://jupyterlab-realtime-collaboration.readthedocs.io>`_
43+
A Jupyter Server Extension Providing Support for Y Documents.
44+
`NbClassic <https://jupyterlab.readthedocs.io>`_
45+
Jupyter notebook as a Jupyter Server extension.
46+
`Cylc UI Server <https://cylc.org>`_
47+
A Jupyter Server extension that serves the cylc-ui web application for
48+
monitoring and controlling Cylc workflows.
49+
50+
For more information on extensions, see :ref:`extensions`.
51+
52+
2453
Who's this for?
2554
---------------
2655

@@ -31,7 +60,8 @@ The Jupyter Server is a highly technical piece of the Jupyter Stack, so we've se
3160
3. :ref:`Developers <developers>`: people writing Jupyter Server extensions and web applications.
3261
4. :ref:`Contributors <contributors>`: people contributing directly to the Jupyter Server library.
3362

34-
If you finds gaps in our documentation, please open an issue (or better, a pull request) on the Jupyter Server `Github repo <https://github.com/jupyter/jupyter_server>`_.
63+
If you finds gaps in our documentation, please open an issue (or better, a pull request) on the Jupyter Server `Github repo <https://github.com/jupyter-server/jupyter_server>`_.
64+
3565

3666
Table of Contents
3767
-----------------

docs/source/other/links.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ List of helpful links
22
=====================
33

44
* :ref:`Frequently Asked Questions <faq>`
5-
* `Jupyter Server Github Repo <https://github.com/jupyter/jupyter_server>`_
5+
* `Jupyter Server Github Repo <https://github.com/jupyter-server/jupyter_server>`_
66
* `JupyterLab Github Repo <https://github.com/jupyterlab/jupyterlab>`_
77
* `Jupyter Notebook Github Repo <https://github.com/jupyter/notebook>`_
88
* `Jupyterhub Github Repo <https://github.com/jupyterhub/jupyterhub>`_

docs/source/users/help.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
Getting Help
44
============
55

6-
If you run into any issues or bugs, please open an `issue on Github <https://github.com/jupyter/jupyter_server/issues>`_.
6+
If you run into any issues or bugs, please open an `issue on Github <https://github.com/jupyter-server/jupyter_server/issues>`_.
77

88
We'd also love to have you come by our :ref:`Team Meetings <contributors-team-meetings-roadmap-calendar>`.

0 commit comments

Comments
 (0)