diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst new file mode 100644 index 0000000..764ca02 --- /dev/null +++ b/docs/contributing/index.rst @@ -0,0 +1,17 @@ +============ +Contributing +============ + +We want you to contribute to TLJH in the ways that are most useful +and exciting to you. This section contains documentation helpful +to people contributing in various ways. + +.. toctree:: + :titlesonly: + + docs + code-review + dev-setup + tests + plugins + packages diff --git a/docs/howto/index.rst b/docs/howto/index.rst new file mode 100644 index 0000000..c17303e --- /dev/null +++ b/docs/howto/index.rst @@ -0,0 +1,62 @@ +How-To Guides +============= + +How-To guides answer the question 'How do I...?' for a lot of topics. + +Content and Data +---------------- + +.. toctree:: + :titlesonly: + + content/nbgitpuller + content/add-data + content/share-data + +The user environment +-------------------- + +.. toctree:: + :titlesonly: + + env/user-environment + env/notebook-interfaces + env/server-resources + +Authentication +-------------- + +We have a special set of How-To Guides on using various forms of authentication +with your JupyterHub. For more information on Authentication, see +:ref:`topic/authenticator-configuration` + +.. toctree:: + :titlesonly: + + auth/dummy + auth/github + auth/google + auth/firstuse + auth/nativeauth + +Administration and security +--------------------------- + +.. toctree:: + :titlesonly: + + admin/admin-users + admin/resource-estimation + admin/resize + admin/nbresuse + admin/https + admin/enable-extensions + +Cloud provider configuration +---------------------------- + +.. toctree:: + :titlesonly: + + providers/digitalocean + providers/azure \ No newline at end of file diff --git a/docs/images/logo/logo.png b/docs/images/logo/logo.png index 7cdfc55..269ba4b 100644 Binary files a/docs/images/logo/logo.png and b/docs/images/logo/logo.png differ diff --git a/docs/index.rst b/docs/index.rst index c4fa181..4eab5cf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -27,15 +27,9 @@ We have a bunch of tutorials to get you started. .. toctree:: :titlesonly: - :caption: Installation + :maxdepth: 2 - install/digitalocean - install/ovh - install/jetstream - install/google - install/amazon - install/azure - install/custom-server + install/index Once you are ready to run your server for real, it's a good idea to proceed directly to :doc:`howto/admin/https`. @@ -45,68 +39,10 @@ How-To Guides How-To guides answer the question 'How do I...?' for a lot of topics. -Content and Data ----------------- - .. toctree:: - :titlesonly: - :caption: Content and data + :maxdepth: 2 - howto/content/nbgitpuller - howto/content/add-data - howto/content/share-data - -The user environment --------------------- - -.. toctree:: - :titlesonly: - :caption: The user environment - - howto/env/user-environment - howto/env/notebook-interfaces - howto/env/server-resources - -Authentication --------------- - -We have a special set of How-To Guides on using various forms of authentication -with your JupyterHub. For more information on Authentication, see -:ref:`topic/authenticator-configuration` - -.. toctree:: - :titlesonly: - :caption: Authentication - - howto/auth/dummy - howto/auth/github - howto/auth/google - howto/auth/firstuse - howto/auth/nativeauth - -Administration and security ---------------------------- - -.. toctree:: - :titlesonly: - :caption: Administration and security - - howto/admin/admin-users - howto/admin/resource-estimation - howto/admin/resize - howto/admin/nbresuse - howto/admin/https - howto/admin/enable-extensions - -Cloud provider configuration ----------------------------- - -.. toctree:: - :titlesonly: - :caption: Cloud provider configuration - - howto/providers/digitalocean - howto/providers/azure + howto/index Topic Guides ============ @@ -115,17 +51,9 @@ Topic guides provide in-depth explanations of specific topics. .. toctree:: :titlesonly: - :caption: Topic guides + :maxdepth: 2 - topic/whentouse - topic/requirements - topic/security - topic/customizing-installer - topic/installer-actions - topic/tljh-config - topic/authenticator-configuration - topic/escape-hatch - topic/idle-culler + topic/index Troubleshooting @@ -136,21 +64,9 @@ guides help you find what is broken & hopefully fix it. .. toctree:: :titlesonly: - :caption: Troubleshooting + :maxdepth: 2 - troubleshooting/logs - -Often, your issues are not related to TLJH itself but to the cloud provider -your server is running on. We have some documentation on common issues you -might run into with various providers and how to fix them. We welcome contributions -here to better support your favorite provider! - -.. toctree:: - :titlesonly: - - troubleshooting/providers/google - troubleshooting/providers/amazon - troubleshooting/providers/custom + troubleshooting/index Contributing ============ @@ -161,11 +77,6 @@ to people contributing in various ways. .. toctree:: :titlesonly: - :caption: Contributing + :maxdepth: 2 - contributing/docs - contributing/code-review - contributing/dev-setup - contributing/tests - contributing/plugins - contributing/packages + contributing/index diff --git a/docs/install/index.rst b/docs/install/index.rst new file mode 100644 index 0000000..a28baca --- /dev/null +++ b/docs/install/index.rst @@ -0,0 +1,22 @@ +========== +Installing +========== + +The Littlest JupyterHub (TLJH) can run on any server that is running at least +**Ubuntu 18.04**. Earlier versions of Ubuntu are not supported. +We have a bunch of tutorials to get you started. + +Tutorials to create a new server from scratch on a cloud provider & run TLJH +on it. These are **recommended** if you do not have much experience setting up +servers. + + .. toctree:: + :titlesonly: + + digitalocean + ovh + jetstream + google + amazon + azure + custom-server diff --git a/docs/topic/index.rst b/docs/topic/index.rst new file mode 100644 index 0000000..6e5744f --- /dev/null +++ b/docs/topic/index.rst @@ -0,0 +1,19 @@ +============ +Topic Guides +============ + +Topic guides provide in-depth explanations of specific topics. + +.. toctree:: + :titlesonly: + :caption: Topic guides + + whentouse + requirements + security + customizing-installer + installer-actions + tljh-config + authenticator-configuration + escape-hatch + idle-culler diff --git a/docs/troubleshooting/index.rst b/docs/troubleshooting/index.rst new file mode 100644 index 0000000..184404c --- /dev/null +++ b/docs/troubleshooting/index.rst @@ -0,0 +1,24 @@ +=============== +Troubleshooting +=============== + +In time, all systems have issues that need to be debugged. Troubleshooting +guides help you find what is broken & hopefully fix it. + +.. toctree:: + :titlesonly: + :caption: Troubleshooting + + logs + +Often, your issues are not related to TLJH itself but to the cloud provider +your server is running on. We have some documentation on common issues you +might run into with various providers and how to fix them. We welcome contributions +here to better support your favorite provider! + +.. toctree:: + :titlesonly: + + providers/google + providers/amazon + providers/custom \ No newline at end of file