Skip to content

Commit

Permalink
Merge pull request #682 from ericsnekbytes/homepage_ecosystem_updates
Browse files Browse the repository at this point in the history
Jupyter ecosystem docs updates
  • Loading branch information
ericsnekbytes committed May 30, 2023
2 parents 38c1496 + b4cffe2 commit e0f7a2d
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 6 deletions.
Binary file added docs/source/_static/_images/jupyterlab.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 39 additions & 5 deletions docs/source/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,42 @@
# Jupyter Project Documentation
# Project Jupyter Documentation

**Welcome to the Jupyter Project documentation**. This website acts as "meta" documentation for the Jupyter ecosystem.
It has a collection of resources to navigate the tools and communities in this ecosystem, and to help you get started.
Welcome to the Project Jupyter documentation site. Jupyter is a large umbrella
project that covers many different software offerings and tools, including the
popular [Jupyter Notebook](https://jupyter-notebook.readthedocs.io/en/stable/)
and [JuyterLab](https://jupyterlab.readthedocs.io/en/stable/) web-based
notebook authoring and editing applications. The Jupyter project and its
subprojects all center around providing tools (and [standards](https://docs.jupyter.org/en/latest/#sub-project-documentation))
for interactive computing with [computational notebooks](#what-is-a-notebook).

## Start Here
## What is a Notebook?

![jupyterlab.png](_static/_images/jupyterlab.png)

**Pictured:** *A computational notebook document, shown inside JupyterLab*

A notebook is a shareable document that combines computer code, plain language
descriptions, data, rich visualizations like 3D models, charts, graphs and
figures, and interactive controls. A notebook, along with an editor (like
JupyterLab), provides a fast interactive environment for prototyping and
explaining code, exploring and visualizing data, and sharing ideas with
others.

## Where do I start?

Most people begin with Jupyter by installing an editing application that fits
their preferences, like [JuyterLab](https://jupyterlab.readthedocs.io/en/stable/)
or [Jupyter Notebook](https://jupyter-notebook.readthedocs.io/en/stable/),
and making their first notebook document:

- Jupyter Notebook offers a simplified, lightweight notebook authoring experience
- JupyterLab offers a feature-rich, tabbed multi-notebook editing environment
with additional tools like a customizable interface layout and system console
- And more... read about additional notebook interfaces [here](projects/user-interfaces)!

You can also develop your own extensions or applications on top of existing Jupyter
software. Check out the subproject sites below for more information.

## More information

These are a few high-level topics to help you learn more about the Jupyter community and ecosystem.

Expand Down Expand Up @@ -53,7 +86,8 @@ These are a few high-level topics to help you learn more about the Jupyter commu

## Sub-project documentation

Sub-projects are major technical and community efforts, and generally have their own documentation for their communities.
Individual sub-projects are typically organized around a key feature of the
Jupyter ecosystem, and have their own community, documentation and governance.
Below is a list of documentation for major parts of the Jupyter ecosystem.

```{panels}
Expand Down
19 changes: 18 additions & 1 deletion docs/source/projects/user-interfaces.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,29 @@ performed using a wide range of programming languages.

.. glossary::

`JupyterLab <https://jupyterlab.readthedocs.io/en/latest/>`__
Advanced web-based application for authoring documents that combine live-code
with narrative text, equations and visualizations.
`Documentation <https://jupyterlab.readthedocs.io/en/latest/>`__ |
`Repo <https://github.com/jupyterlab/jupyterlab>`__

`Jupyter Notebook <https://jupyter-notebook.readthedocs.io/en/latest/>`__
Web-based application for authoring documents that combine live-code
A web-based application for authoring documents that combine live-code
with narrative text, equations and visualizations.
`Documentation <https://jupyter-notebook.readthedocs.io/en/latest/>`__ |
`Repo <https://github.com/jupyter/notebook>`__

`Jupyter Desktop <https://github.com/jupyterlab/jupyterlab-desktop>`__
Desktop application based on JupyterLab for authoring documents that combine live-code
with narrative text, equations and visualizations.
`Repo <https://github.com/jupyterlab/jupyterlab-desktop>`__

`JupyterLite <https://jupyterlite.readthedocs.io/en/latest/>`__
Installation-free application based on JupyterLab for authoring documents that combine live-code
with narrative text, equations and visualizations.
`Documentation <https://jupyterlite.readthedocs.io/en/latest/>`__
`Repo <https://github.com/jupyterlite/jupyterlite>`__

`Jupyter Console <https://jupyter-console.readthedocs.io/en/latest/>`__
Terminal based console for interactive computing.
`Documentation <https://jupyter-console.readthedocs.io/en/latest/>`__ |
Expand Down

0 comments on commit e0f7a2d

Please sign in to comment.