From 8e8c113b00190c80b28f70c0dd8f9b653691a56b Mon Sep 17 00:00:00 2001 From: Oliver Sanders Date: Fri, 5 Apr 2024 10:46:01 +0100 Subject: [PATCH 1/2] docs: add examples of Jupyter Server extensions --- docs/source/developers/extensions.rst | 6 ++++- docs/source/index.rst | 32 ++++++++++++++++++++++++++- 2 files changed, 36 insertions(+), 2 deletions(-) diff --git a/docs/source/developers/extensions.rst b/docs/source/developers/extensions.rst index 5c27d25747..f99c3a68a1 100644 --- a/docs/source/developers/extensions.rst +++ b/docs/source/developers/extensions.rst @@ -6,9 +6,13 @@ Server Extensions 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. -You can check some simple examples on the `examples folder +For examples of jupyter server extensions, see the +:ref:`homepage `. + +To get started writing your own extension, see the simple examples in the `examples folder `_ in the GitHub jupyter_server repository. + Authoring a basic server extension ================================== diff --git a/docs/source/index.rst b/docs/source/index.rst index a3f6abb517..a86b36a309 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,7 +11,8 @@ You've landed on the documentation pages for the **Jupyter Server** Project. Som Introduction ------------ -Jupyter Server is the backend—the core services, APIs, and `REST endpoints`_—to Jupyter web applications. +Jupyter Server is the backend that provides the core services, APIs, and +`REST endpoints`_ for Jupyter web applications. .. note:: @@ -21,6 +22,34 @@ Jupyter Server is the backend—the core services, APIs, and `REST endpoints`_ .. _Jupyter Notebook: https://github.com/jupyter/notebook .. _REST endpoints: https://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/jupyter_server/main/jupyter_server/services/api/api.yaml + +Applications +------------ + +Jupyter Server extensions can use the framework and services provided by +Jupyter Server to create applications and services. + +Examples of Jupyter Server extensions include: + +.. _examples of jupyter server extensions: + +`Jupyter Lab `_ + JupyterLab computational environment. +`Jupyter Resource Usage `_ + Jupyter Notebook Extension for monitoring your own resource usage. +`Jupyter Scheduler `_ + Run Jupyter notebooks as jobs. +`jupyter-collaboration `_ + A Jupyter Server Extension Providing Support for Y Documents. +`NbClassic `_ + Jupyter notebook as a Jupyter Server extension. +`Cylc UI Server `_ + A Jupyter Server extension that serves the cylc-ui web application for + monitoring and controlling Cylc workflows. + +For more information on extensions, see :ref:`extensions`. + + Who's this for? --------------- @@ -33,6 +62,7 @@ The Jupyter Server is a highly technical piece of the Jupyter Stack, so we've se If you finds gaps in our documentation, please open an issue (or better, a pull request) on the Jupyter Server `Github repo `_. + Table of Contents ----------------- From a46d07c4cfc6e821bd4b40ea1e42771a02094ddf Mon Sep 17 00:00:00 2001 From: Oliver Sanders Date: Fri, 5 Apr 2024 10:50:52 +0100 Subject: [PATCH 2/2] docs: s/jupter/jupyter-server/g --- docs/source/conf.py | 2 +- docs/source/contributors/team-meetings.rst | 2 +- docs/source/developers/extensions.rst | 2 +- docs/source/index.rst | 4 ++-- docs/source/other/links.rst | 2 +- docs/source/users/help.rst | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 7f59cb956b..7da4ade09a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -70,7 +70,7 @@ author = "The Jupyter Team" # ghissue config -github_project_url = "https://github.com/jupyter/jupyter_server" +github_project_url = "https://github.com/jupyter-server/jupyter_server" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/docs/source/contributors/team-meetings.rst b/docs/source/contributors/team-meetings.rst index 75d69d232c..05ba92732f 100644 --- a/docs/source/contributors/team-meetings.rst +++ b/docs/source/contributors/team-meetings.rst @@ -23,7 +23,7 @@ Also check out Jupyter Server's roadmap where we track future plans for Jupyter `Jupyter Server 2.0 Discussion `_ -`Archived roadmap `_ +`Archived roadmap `_ Jupyter Calendar ---------------- diff --git a/docs/source/developers/extensions.rst b/docs/source/developers/extensions.rst index f99c3a68a1..be454b26e6 100644 --- a/docs/source/developers/extensions.rst +++ b/docs/source/developers/extensions.rst @@ -10,7 +10,7 @@ For examples of jupyter server extensions, see the :ref:`homepage `. To get started writing your own extension, see the simple examples in the `examples folder -`_ in the GitHub jupyter_server repository. +`_ in the GitHub jupyter_server repository. Authoring a basic server extension diff --git a/docs/source/index.rst b/docs/source/index.rst index a86b36a309..c95abf94a7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,7 +3,7 @@ Welcome! You've landed on the documentation pages for the **Jupyter Server** Project. Some other pages you may have been looking for: -* `Jupyter Server Github Repo `_, the source code we describe in this code. +* `Jupyter Server Github Repo `_, the source code we describe in this code. * `Jupyter Notebook Github Repo `_ , the source code for the classic Notebook. * `JupyterLab Github Repo `_, the JupyterLab server which runs on the Jupyter Server. @@ -60,7 +60,7 @@ The Jupyter Server is a highly technical piece of the Jupyter Stack, so we've se 3. :ref:`Developers `: people writing Jupyter Server extensions and web applications. 4. :ref:`Contributors `: people contributing directly to the Jupyter Server library. -If you finds gaps in our documentation, please open an issue (or better, a pull request) on the Jupyter Server `Github repo `_. +If you finds gaps in our documentation, please open an issue (or better, a pull request) on the Jupyter Server `Github repo `_. Table of Contents diff --git a/docs/source/other/links.rst b/docs/source/other/links.rst index 935ddc53cb..da951129a0 100644 --- a/docs/source/other/links.rst +++ b/docs/source/other/links.rst @@ -2,7 +2,7 @@ List of helpful links ===================== * :ref:`Frequently Asked Questions ` -* `Jupyter Server Github Repo `_ +* `Jupyter Server Github Repo `_ * `JupyterLab Github Repo `_ * `Jupyter Notebook Github Repo `_ * `Jupyterhub Github Repo `_ diff --git a/docs/source/users/help.rst b/docs/source/users/help.rst index b290e1bb07..3f97e84f40 100644 --- a/docs/source/users/help.rst +++ b/docs/source/users/help.rst @@ -3,6 +3,6 @@ Getting Help ============ -If you run into any issues or bugs, please open an `issue on Github `_. +If you run into any issues or bugs, please open an `issue on Github `_. We'd also love to have you come by our :ref:`Team Meetings `.