diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst index cfbfcb17..7ce11d2a 100644 --- a/docs/source/api/index.rst +++ b/docs/source/api/index.rst @@ -8,7 +8,7 @@ The JupyterHub API :Date: |today| JupyterHub also provides a REST API for administration of the Hub and users. -The documentation on `Using JupyterHub's REST API <../rest.html>`_ provides +The documentation on `Using JupyterHub's REST API <../reference/rest.html>`_ provides information on: - what you can do with the API diff --git a/docs/source/getting-started/authenticators-users-basics.md b/docs/source/getting-started/authenticators-users-basics.md index 8a834aa4..36ce9885 100644 --- a/docs/source/getting-started/authenticators-users-basics.md +++ b/docs/source/getting-started/authenticators-users-basics.md @@ -1,4 +1,4 @@ -# Authentication and Users +# Authentication and User Basics The default Authenticator uses [PAM][] to authenticate system users with their username and password. With the default Authenticator, any user diff --git a/docs/source/getting-started/config-basics.md b/docs/source/getting-started/config-basics.md index 3ba24860..71fca2c0 100644 --- a/docs/source/getting-started/config-basics.md +++ b/docs/source/getting-started/config-basics.md @@ -1,8 +1,8 @@ # Configuration Basics The section contains basic information about configuring settings for a JupyterHub -deployment. The [configuration reference](./configuration-guide.html) -provides additional detail. +deployment. The [Technical Reference](../reference/index.html) +documentation provides additional details. This section will help you learn how to: @@ -80,7 +80,7 @@ The default authentication and process spawning mechanisms can be replaced, and specific [authenticators](./authenticators-users-basics.html) and [spawners](./spawners-basics.html) can be set in the configuration file. This enables JupyterHub to be used with a variety of authentication methods or -process control and deployment environments. [Some examples](./config-examples.html), +process control and deployment environments. [Some examples](../reference/config-examples.html), meant as illustration, are: - Using GitHub OAuth instead of PAM with [OAuthenticator](https://github.com/jupyterhub/oauthenticator) diff --git a/docs/source/getting-started/services-basics.md b/docs/source/getting-started/services-basics.md index ec352c9a..018ab68b 100644 --- a/docs/source/getting-started/services-basics.md +++ b/docs/source/getting-started/services-basics.md @@ -29,14 +29,14 @@ Hub via the REST API. To run such an external service, an API token must be created and provided to the service. -As of [version 0.6.0](./changelog.html), the preferred way of -generating an API token is: +As of [version 0.6.0](../changelog.html), the preferred way of doing +this is to first generate an API token: ```bash openssl rand -hex 32 ``` -In [version 0.8.0](./changelog.html), a TOKEN request page for +In [version 0.8.0](../changelog.html), a TOKEN request page for generating an API token is available from the JupyterHub user interface: ![Request API TOKEN page](images/api-token-request.png) @@ -116,6 +116,4 @@ variable. Run `cull_idle_servers.py` manually. python cull_idle_servers.py [--timeout=900] [--url=http://127.0.0.1:8081/hub/api] ``` - - [cull_idle_servers]: https://github.com/jupyterhub/jupyterhub/blob/master/examples/cull-idle/cull_idle_servers.py \ No newline at end of file diff --git a/docs/source/reference/config-examples.md b/docs/source/reference/config-examples.md index cf05c66b..7ade9ba6 100644 --- a/docs/source/reference/config-examples.md +++ b/docs/source/reference/config-examples.md @@ -207,5 +207,5 @@ server { ``` Now just restart `nginx`, restart the JupyterHub, and enjoy accessing -https://HUB.DOMAIN.TLD while serving other content securely on -https://NO_HUB.DOMAIN.TLD. +`https://HUB.DOMAIN.TLD` while serving other content securely on +`https://NO_HUB.DOMAIN.TLD`. diff --git a/docs/source/reference/rest.md b/docs/source/reference/rest.md index 1fdd2da7..c3b164ea 100644 --- a/docs/source/reference/rest.md +++ b/docs/source/reference/rest.md @@ -27,7 +27,7 @@ Hub. To send requests using JupyterHub API, you must pass an API token with the request. -As of [version 0.6.0](./changelog.html), the preferred way of +As of [version 0.6.0](../changelog.html), the preferred way of generating an API token is: ```bash @@ -38,7 +38,6 @@ This `openssl` command generates a potential token that can then be added to JupyterHub using `.api_tokens` configuration setting in `jupyterhub_config.py`. - Alternatively, use the `jupyterhub token` command to generate a token for a specific hub user by passing the 'username': @@ -49,12 +48,11 @@ jupyterhub token This command generates a random string to use as a token and registers it for the given user with the Hub's database. -In [version 0.8.0](./changelog.html), a TOKEN request page for +In [version 0.8.0](../changelog.html), a TOKEN request page for generating an API token is available from the JupyterHub user interface: ![Request API TOKEN page](images/api-token-request.png) - ## Add API tokens to the config file You may also add a dictionary of API tokens and usernames to the hub's @@ -128,5 +126,5 @@ Note: The Swagger specification is being renamed the [OpenAPI Initiative][]. [interactive style on swagger's petstore]: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyterhub/jupyterhub/master/docs/rest-api.yml#!/default [OpenAPI Initiative]: https://www.openapis.org/ -[JupyterHub REST API]: ./_static/rest-api/index.html +[JupyterHub REST API]: ../_static/rest-api/index.html [Jupyter Notebook REST API]: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml diff --git a/docs/source/reference/services.md b/docs/source/reference/services.md index 9b81bb2f..c358ad74 100644 --- a/docs/source/reference/services.md +++ b/docs/source/reference/services.md @@ -355,7 +355,7 @@ section on securing the notebook viewer. [requests]: http://docs.python-requests.org/en/master/ -[services_auth]: api/services.auth.html -[HubAuth]: api/services.auth.html#jupyterhub.services.auth.HubAuth -[HubAuthenticated]: api/services.auth.html#jupyterhub.services.auth.HubAuthenticated +[services_auth]: ../api/services.auth.html +[HubAuth]: ../api/services.auth.html#jupyterhub.services.auth.HubAuth +[HubAuthenticated]: ../api/services.auth.html#jupyterhub.services.auth.HubAuthenticated [nbviewer example]: https://github.com/jupyter/nbviewer#securing-the-notebook-viewer diff --git a/docs/source/reference/technical-overview.md b/docs/source/reference/technical-overview.md index 7eb9014e..15fd57db 100644 --- a/docs/source/reference/technical-overview.md +++ b/docs/source/reference/technical-overview.md @@ -111,7 +111,7 @@ working directory: This file needs to persist so that a **Hub** server restart will avoid invalidating cookies. Conversely, deleting this file and restarting the server effectively invalidates all login cookies. The cookie secret file is discussed - in the [Cookie Secret section of the Security Settings document](./security-basics.html). + in the [Cookie Secret section of the Security Settings document](../getting-started/security-basics.html). The location of these files can be specified via configuration settings. It is recommended that these files be stored in standard UNIX filesystem locations, diff --git a/docs/source/tutorials/index.rst b/docs/source/tutorials/index.rst index 49e0ad60..3ac3ddf9 100644 --- a/docs/source/tutorials/index.rst +++ b/docs/source/tutorials/index.rst @@ -1,7 +1,7 @@ Tutorials ========= +This section provides links to documentation that helps a user do a specific +task. -How do I? - -Zero to JupyterHub \ No newline at end of file +- [Zero to JupyterHub with Kubernetes](https://zero-to-jupyterhub.readthedocs.io/en/latest/) \ No newline at end of file