Moved last set of Tutorials

This commit is contained in:
alwasega
2023-02-03 15:57:35 +03:00
parent 63f164ca53
commit f857b17022
13 changed files with 44 additions and 37 deletions

View File

@@ -1,3 +1,5 @@
(changelog)=
# Changelog # Changelog
For detailed changes from the prior release, click on the version number, and For detailed changes from the prior release, click on the version number, and

View File

@@ -1,17 +0,0 @@
# Get Started
This section covers how to configure and customize JupyterHub for your
needs. It contains information about authentication, networking, security, and
other topics that are relevant to individuals or organizations deploying their
own JupyterHub.
```{toctree}
:maxdepth: 2
config-basics
networking-basics
security-basics
authenticators-users-basics
spawners-basics
services-basics
```

View File

@@ -81,13 +81,6 @@ Today, you can find two main use cases:
_It is important to evaluate these distributions before you can continue with the _It is important to evaluate these distributions before you can continue with the
configuration of JupyterHub_. configuration of JupyterHub_.
### Getting Started
```{toctree}
:maxdepth: 2
getting-started/index
```
### Technical Reference ### Technical Reference

View File

@@ -1,3 +1,5 @@
(reference-index)=
# Technical Reference # Technical Reference
This section covers more of the details of the JupyterHub architecture, as well as This section covers more of the details of the JupyterHub architecture, as well as
@@ -13,7 +15,6 @@ authenticators
spawners spawners
services services
rest-api rest-api
server-api
monitoring monitoring
database database
../events/index ../events/index

View File

@@ -110,7 +110,7 @@ working directory:
This file needs to persist so that a **Hub** server restart will avoid This file needs to persist so that a **Hub** server restart will avoid
invalidating cookies. Conversely, deleting this file and restarting the server invalidating cookies. Conversely, deleting this file and restarting the server
effectively invalidates all login cookies. The cookie secret file is discussed effectively invalidates all login cookies. The cookie secret file is discussed
in the [Cookie Secret section of the Security Settings document](../getting-started/security-basics.md). in the [Cookie Secret section of the Security Settings document](security-basics).
The location of these files can be specified via configuration settings. It is The location of these files can be specified via configuration settings. It is
recommended that these files be stored in standard UNIX filesystem locations, recommended that these files be stored in standard UNIX filesystem locations,

View File

@@ -252,7 +252,7 @@ data: {"progress": 100, "ready": true, "message": "Server ready at /user/test-us
Here is a Python example for consuming an event stream: Here is a Python example for consuming an event stream:
```{literalinclude} ../../../examples/server-api/start-stop-server.py ```{literalinclude} ../../../../examples/server-api/start-stop-server.py
:language: python :language: python
:pyobject: event_stream :pyobject: event_stream
``` ```
@@ -285,7 +285,7 @@ The only way to wait for a server to stop is to poll it and wait for the server
This Python code snippet can be used to stop a server and the wait for the process to complete: This Python code snippet can be used to stop a server and the wait for the process to complete:
```{literalinclude} ../../../examples/server-api/start-stop-server.py ```{literalinclude} ../../../../examples/server-api/start-stop-server.py
:language: python :language: python
:pyobject: stop_server :pyobject: stop_server
``` ```
@@ -325,7 +325,7 @@ In summary, the processes involved in managing servers on behalf of users are:
The example below demonstrates starting and stopping servers via the JupyterHub API, The example below demonstrates starting and stopping servers via the JupyterHub API,
including waiting for them to start via the progress API and waiting for them to stop by polling the user model. including waiting for them to start via the progress API and waiting for them to stop by polling the user model.
```{literalinclude} ../../../examples/server-api/start-stop-server.py ```{literalinclude} ../../../../examples/server-api/start-stop-server.py
:language: python :language: python
:start-at: def event_stream :start-at: def event_stream
:end-before: def main :end-before: def main

View File

@@ -1,7 +1,7 @@
# Configuration Basics # Configuration Basics
This section contains basic information about configuring settings for a JupyterHub This section contains basic information about configuring settings for a JupyterHub
deployment. The [Technical Reference](../reference/index) deployment. The [Technical Reference](reference-index)
documentation provides additional details. documentation provides additional details.
This section will help you learn how to: This section will help you learn how to:

View File

@@ -14,7 +14,7 @@ document will:
- explain some basic information about API tokens - explain some basic information about API tokens
- clarify that API tokens can be used to authenticate to - clarify that API tokens can be used to authenticate to
single-user servers as of [version 0.8.0](../changelog) single-user servers as of [version 0.8.0](changelog)
- show how the [jupyterhub_idle_culler][] script can be: - show how the [jupyterhub_idle_culler][] script can be:
- used in a Hub-managed service - used in a Hub-managed service
- run as a standalone script - run as a standalone script
@@ -29,19 +29,19 @@ Hub via the REST API.
To run such an external service, an API token must be created and To run such an external service, an API token must be created and
provided to the service. provided to the service.
As of [version 0.6.0](../changelog), the preferred way of doing As of [version 0.6.0](changelog), the preferred way of doing
this is to first generate an API token: this is to first generate an API token:
```bash ```bash
openssl rand -hex 32 openssl rand -hex 32
``` ```
In [version 0.8.0](../changelog), a TOKEN request page for In [version 0.8.0](changelog), a TOKEN request page for
generating an API token is available from the JupyterHub user interface: generating an API token is available from the JupyterHub user interface:
![Request API TOKEN page](../images/token-request.png) ![Request API TOKEN page](/images/token-request.png)
![API TOKEN success page](../images/token-request-success.png) ![API TOKEN success page](/images/token-request-success.png)
### Step 2: Pass environment variable with token to the Hub ### Step 2: Pass environment variable with token to the Hub

View File

@@ -1,10 +1,10 @@
# Tutorials # Tutorials
This section of the documentation provides step-by-step tutorials to help you achieve a specific goal. The tutorials should be a good place to start learning about JupyterHub and how it works. The *Tutorials* provide step-by-step lessons to help you achieve a specific goal. The tutorials should be a good place to start learning about JupyterHub and how it works.
## Installation ## Installation
These sections cover how to get up-and-running with JupyterHub. They cover This section covers how to get up-and-running with JupyterHub. It covers
some basics of the tools needed to deploy JupyterHub as well as how to get it some basics of the tools needed to deploy JupyterHub as well as how to get it
running on your own infrastructure. running on your own infrastructure.
@@ -15,3 +15,31 @@ installation/quickstart
installation/installation-basics installation/installation-basics
installation/quickstart-docker installation/quickstart-docker
``` ```
## Getting Started
This section covers how to configure and customize JupyterHub for your
needs. It contains information about authentication, networking, security, and
other topics that are relevant to individuals or organizations deploying their
own JupyterHub.
```{toctree}
:maxdepth: 1
getting-started/config-basics
getting-started/networking-basics
getting-started/security-basics
getting-started/authenticators-users-basics
getting-started/services-basics
getting-started/spawners-basics
```
## Working with the JupyterHub API
JupyterHub's functionalities can be accessed using its API. In this section, we cover how to use the JupyterHub API to achieve specific goals, for example, starting servers.
```{toctree}
:maxdepth: 1
api/server-api
```