Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: list server extensions #1412

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributors/team-meetings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Also check out Jupyter Server's roadmap where we track future plans for Jupyter

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

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

Jupyter Calendar
----------------
Expand Down
8 changes: 6 additions & 2 deletions docs/source/developers/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@ 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
<https://github.com/jupyter/jupyter_server/tree/main/examples/simple>`_ in the GitHub jupyter_server repository.
For examples of jupyter server extensions, see the
:ref:`homepage <examples of jupyter server extensions>`.

To get started writing your own extension, see the simple examples in the `examples folder
<https://github.com/jupyter-server/jupyter_server/tree/main/examples/simple>`_ in the GitHub jupyter_server repository.


Authoring a basic server extension
==================================
Expand Down
36 changes: 33 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@ 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 <https://github.com/jupyter/jupyter_server>`_, the source code we describe in this code.
* `Jupyter Server Github Repo <https://github.com/jupyter-server/jupyter_server>`_, the source code we describe in this code.
* `Jupyter Notebook Github Repo <https://github.com/jupyter/notebook>`_ , the source code for the classic Notebook.
* `JupyterLab Github Repo <https://github.com/jupyterlab/jupyterlab>`_, the JupyterLab server which runs on the Jupyter Server.


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::

Expand All @@ -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 <https://jupyterlab.readthedocs.io>`_
JupyterLab computational environment.
`Jupyter Resource Usage <https://github.com/jupyter-server/jupyter-resource-usage>`_
Jupyter Notebook Extension for monitoring your own resource usage.
`Jupyter Scheduler <https://jupyter-scheduler.readthedocs.io>`_
Run Jupyter notebooks as jobs.
`jupyter-collaboration <https://jupyterlab-realtime-collaboration.readthedocs.io>`_
A Jupyter Server Extension Providing Support for Y Documents.
`NbClassic <https://jupyterlab.readthedocs.io>`_
Jupyter notebook as a Jupyter Server extension.
`Cylc UI Server <https://cylc.org>`_
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?
---------------

Expand All @@ -31,7 +60,8 @@ The Jupyter Server is a highly technical piece of the Jupyter Stack, so we've se
3. :ref:`Developers <developers>`: people writing Jupyter Server extensions and web applications.
4. :ref:`Contributors <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 <https://github.com/jupyter/jupyter_server>`_.
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>`_.


Table of Contents
-----------------
Expand Down
2 changes: 1 addition & 1 deletion docs/source/other/links.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ List of helpful links
=====================

* :ref:`Frequently Asked Questions <faq>`
* `Jupyter Server Github Repo <https://github.com/jupyter/jupyter_server>`_
* `Jupyter Server Github Repo <https://github.com/jupyter-server/jupyter_server>`_
* `JupyterLab Github Repo <https://github.com/jupyterlab/jupyterlab>`_
* `Jupyter Notebook Github Repo <https://github.com/jupyter/notebook>`_
* `Jupyterhub Github Repo <https://github.com/jupyterhub/jupyterhub>`_
Expand Down
2 changes: 1 addition & 1 deletion docs/source/users/help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
Getting Help
============

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

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