Merge pull request #101 from yuvipanda/convenience-docs

Add docs on 'convenience' packages
jupyterhub · Feb 8, 2019 · 79bf5e8 · 79bf5e8
2 parents 2107810 + d47fe68
commit 79bf5e8
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 12 deletions.
diff --git a/contrib/README.rst → docs/convenience/new.rst b/contrib/README.rst → docs/convenience/new.rst
@@ -1,21 +1,16 @@
-=================================
-User Contributed Server Processes
-=================================
+.. _convenience/new:
 
-This directory contains various python packages that can be
-pip installed to get popular services that are commonly
-used with jupyter-server-proxy working.
-
-Making a new package
-====================
+================================
+Making a new convenience package
+================================
 
 There is a `cookiecutter <https://github.com/audreyr/cookiecutter>`_
-template provided here that can be used to make new packages.
+template provided in this repo that can be used to make new packages.
 
 .. code:: bash
 
    pip install cookiecutter
-   cookiecutter template
+   cookiecutter contrib/template -o contrib/
 
 This should ask you a bunch of questions, and generate a directory
 named after your project with a python package. From there, you should:

diff --git a/docs/convenience/packages/theia.rst b/docs/convenience/packages/theia.rst
@@ -0,0 +1 @@
+../../../contrib/theia/README.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -35,6 +35,25 @@ Contents
    launchers
    arbitrary-ports
 
+
+Convenience packages for popular applications
+=============================================
+
+This repository contains various python packages
+set up with appropriate :ref:`entrypoints <server-process/package>`
+so pip installing them automatically sets up common config
+for popular applications.
+
+.. toctree::
+   :maxdepth: 1
+
+   convenience/packages/theia
+
+
+Making and contributing a :ref:`new convenience package <convenience/new>`
+is very much appreciated.
+
+
 Contributing
 ============
 
@@ -43,4 +62,5 @@ Contributions of all kinds - documentation, issues, blog posts, code, are most w
 .. toctree::
    :maxdepth: 2
 
-   contributing/release
+   contributing/release
+   convenience/new
diff --git a/docs/server-process.rst b/docs/server-process.rst
@@ -196,6 +196,8 @@ if we want tighter control over what process is spawned.
    in your notebook url. The URL path is specified by the key,
    but this should be made more configurable in the future.
 
+.. _server-process/package:
+
 Specifying config from python packages
 ======================================