Moved first half of HowTo documentation

This commit is contained in:
alwasega
2023-01-25 23:51:36 +03:00
parent 38ba275367
commit ee43ebeab5
13 changed files with 18 additions and 12 deletions

View File

@@ -11,7 +11,7 @@
:Release: {{ version }} :Release: {{ version }}
JupyterHub also provides a REST API for administration of the Hub and users. JupyterHub also provides a REST API for administration of the Hub and users.
The documentation on [Using JupyterHub's REST API](../reference/rest.md) provides The documentation on [Using JupyterHub's REST API](rest-api) provides
information on: information on:
- what you can do with the API - what you can do with the API

View File

@@ -581,7 +581,7 @@ and consider assigning only the necessary roles and scopes.
[rbac]: ./rbac/index.md [rbac]: ./rbac/index.md
JupyterHub 2.0 requires an update to the database schema, JupyterHub 2.0 requires an update to the database schema,
so **make sure to [read the upgrade documentation and backup your database](admin/upgrading) so **make sure to [read the upgrade documentation and backup your database](upgrading-jupyterhub)
before upgrading**. before upgrading**.
:::{admonition} stop all servers before upgrading :::{admonition} stop all servers before upgrading

View File

@@ -99,4 +99,4 @@ maintenance, re-configuration, etc.), then user connections are not
interrupted. For simplicity, by default the hub starts the proxy interrupted. For simplicity, by default the hub starts the proxy
automatically, so if the hub restarts, the proxy restarts, and user automatically, so if the hub restarts, the proxy restarts, and user
connections are interrupted. It is easy to run the proxy separately, connections are interrupted. It is easy to run the proxy separately,
for information see [the separate proxy page](../reference/separate-proxy). for information see [the separate proxy page](separate-proxy).

View File

@@ -3,6 +3,12 @@
The _How-to_ guides provide practical step-by-step details to help you achieve a particular goal. They are useful when you are trying to get something done but require you to understand and adapt the steps to your specific usecase. The _How-to_ guides provide practical step-by-step details to help you achieve a particular goal. They are useful when you are trying to get something done but require you to understand and adapt the steps to your specific usecase.
```{toctree} ```{toctree}
:maxdepth: 2 :maxdepth: 1
api-only
proxy
rest
separate-proxy
templates
upgrading
``` ```

View File

@@ -19,7 +19,7 @@ Hub.
## What you can do with the API ## What you can do with the API
Using the [JupyterHub REST API][], you can perform actions on the Hub, Using the [JupyterHub REST API](jupyterhub-rest-api), you can perform actions on the Hub,
such as: such as:
- Checking which users are active - Checking which users are active
@@ -320,7 +320,7 @@ or kubernetes pods.
## Learn more about the API ## Learn more about the API
You can see the full [JupyterHub REST API][] for more details. You can see the full [JupyterHub REST API](jupyterhub-rest-api) for more details.
[openapi initiative]: https://www.openapis.org/ [openapi initiative]: https://www.openapis.org/
[jupyterhub rest api]: ./rest-api [jupyterhub rest api]: ./rest-api

View File

@@ -1,3 +1,5 @@
(separate-proxy)=
# Running proxy separately from the hub # Running proxy separately from the hub
## Background ## Background

View File

@@ -1,3 +1,5 @@
(upgrading-jupyterhub)=
# Upgrading JupyterHub # Upgrading JupyterHub
JupyterHub offers easy upgrade pathways between minor versions. This JupyterHub offers easy upgrade pathways between minor versions. This

View File

@@ -7,7 +7,6 @@ well as other information relevant to running your own JupyterHub over time.
:maxdepth: 2 :maxdepth: 2
admin/capacity-planning admin/capacity-planning
admin/upgrading
admin/log-messages admin/log-messages
changelog changelog
``` ```

View File

@@ -12,15 +12,10 @@ websecurity
authenticators authenticators
spawners spawners
services services
proxy
separate-proxy
rest
rest-api rest-api
server-api server-api
monitoring monitoring
database database
templates
api-only
../events/index ../events/index
config-user-env config-user-env
config-examples config-examples

View File

@@ -1,3 +1,5 @@
(jupyterhub-rest-api)=
# JupyterHub REST API # JupyterHub REST API
Below is an interactive view of JupyterHub's OpenAPI specification. Below is an interactive view of JupyterHub's OpenAPI specification.