Skip to content

Commit 67f5d18

Browse files
committed
Cleanup README.md
1 parent 99a4b45 commit 67f5d18

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Possible **use cases** include:
1010
- Creating a JupyterHub demo environment that you can spin up relatively
1111
quickly.
1212
- Providing a multi-user Jupyter Notebook environment for small classes,
13-
teams, or departments.
13+
teams or departments.
1414

1515
## Disclaimer
1616

@@ -31,7 +31,7 @@ Key components of this reference deployment are:
3131
in a Docker container on the host.
3232

3333
- **Authenticator**: Uses [Native Authenticator](https://github.com/jupyterhub/nativeauthenticator) to authenticate users.
34-
Any user will be allowed to sign-up
34+
Any user will be allowed to sign up.
3535

3636
- **Spawner**:Uses [DockerSpawner](https://github.com/jupyter/dockerspawner)
3737
to spawn single-user Jupyter Notebook servers in separate Docker
@@ -56,7 +56,7 @@ This deployment uses Docker, via [Docker Compose](https://docs.docker.com/compos
5656

5757
This deployment uses [JupyterHub Native Authenticator](https://native-authenticator.readthedocs.io/en/latest/) to authenticate users.
5858

59-
1. An single `admin` user will be enabled be default. Any user will be allowed to signup.
59+
1. An single `admin` user will be enabled by default. Any user will be allowed to sign up.
6060

6161
## Build the JupyterHub Docker image
6262

@@ -79,7 +79,7 @@ To specify which Notebook image to spawn for users, you set the value of the
7979
Whether you build a custom Notebook image or pull an image from a public or
8080
private Docker registry, the image must reside on the host.
8181

82-
If the Notebook image does not exist on host, Docker will attempt to pull the
82+
If the Notebook image does not exist on the host, Docker will attempt to pull the
8383
image the first time a user attempts to start his or her server. In such cases,
8484
JupyterHub may timeout if the image being pulled is large, so it is better to
8585
pull the image to the host before running JupyterHub.
@@ -142,7 +142,7 @@ c.DockerSpawner.image = os.environ['DOCKER_NOTEBOOK_IMAGE']
142142

143143
### If I change the name of the Notebook server image to spawn, do I need to restart JupyterHub?
144144

145-
Yes. JupyterHub reads its configuration which includes the container image
145+
Yes. JupyterHub reads its configuration, which includes the container image
146146
name for DockerSpawner. JupyterHub uses this configuration to determine the
147147
Notebook server image to spawn during startup.
148148

@@ -156,9 +156,9 @@ again to their individual notebook servers. However, users may need to
156156
refresh their browser to re-establish connections to the running Notebook
157157
kernels.
158158

159-
### How can I backup a user's notebook directory?
159+
### How can I back up a user's notebook directory?
160160

161-
There are multiple ways to [backup and restore](https://docs.docker.com/engine/userguide/containers/dockervolumes/#backup-restore-or-migrate-data-volumes) data in Docker containers.
161+
There are multiple ways to [Back up and restore data](https://docs.docker.com/desktop/backup-and-restore/) in Docker containers.
162162

163163
Suppose you have the following running containers:
164164

@@ -178,7 +178,7 @@ In this deployment, the user's notebook directories (`/home/jovyan/work`) are ba
178178
[{jtyberg /var/lib/docker/volumes/jtyberg/_data /home/jovyan/work local rw true rprivate}]
179179
```
180180

181-
We can backup the user's notebook directory by running a separate container that mounts the user's volume and creates a tarball of the directory.
181+
We can back up the user's notebook directory by running a separate container that mounts the user's volume and creates a tarball of the directory.
182182

183183
```bash
184184
docker run --rm \

0 commit comments

Comments
 (0)