mirror of
https://github.com/jupyterhub/the-littlest-jupyterhub.git
synced 2025-12-18 21:54:05 +08:00
updating index files
This commit is contained in:
Chris Holdgraf
17
docs/contributing/index.rst
Normal file
17
docs/contributing/index.rst
Normal file
@@ -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
|
||||
62
docs/howto/index.rst
Normal file
62
docs/howto/index.rst
Normal file
@@ -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
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 7.7 KiB |
109
docs/index.rst
109
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
|
||||
|
||||
22
docs/install/index.rst
Normal file
22
docs/install/index.rst
Normal file
@@ -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
|
||||
19
docs/topic/index.rst
Normal file
19
docs/topic/index.rst
Normal file
@@ -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
|
||||
24
docs/troubleshooting/index.rst
Normal file
24
docs/troubleshooting/index.rst
Normal file
@@ -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
|
||||
Reference in New Issue
Block a user