Correct docstring that was preventing build

This commit is contained in:
Carol Willing
2017-08-07 12:12:44 -07:00
parent ac13140083
commit 61e263b160

View File

@@ -1,18 +1,15 @@
"""A service is a process that talks to JupyterHub """A service is a process that talks to JupyterHub.
Cases Types of services:
----- Managed:
Managed:
- managed by JupyterHub (always subprocess, no custom Spawners) - managed by JupyterHub (always subprocess, no custom Spawners)
- always a long-running process - always a long-running process
- managed services are restarted automatically if they exit unexpectedly - managed services are restarted automatically if they exit unexpectedly
Unmanaged: Unmanaged:
- managed by external service (docker, systemd, etc.) - managed by external service (docker, systemd, etc.)
- do not need to be long-running processes, or processes at all - do not need to be long-running processes, or processes at all
URL: needs a route added to the proxy. URL: needs a route added to the proxy.
- Public route will always be /services/service-name - Public route will always be /services/service-name
- url specified in config - url specified in config
@@ -23,9 +20,6 @@ API access:
- not admin: tokens will only have non-admin access - not admin: tokens will only have non-admin access
(not much they can do other than defer to Hub for auth) (not much they can do other than defer to Hub for auth)
Examples
--------
An externally managed service running on a URL:: An externally managed service running on a URL::
{ {