Wording in the examples (review)

This commit is contained in:
romainx
2022-01-20 19:41:50 +01:00
parent c6f7d4637e
commit 88d83c9f16

View File

@@ -21,9 +21,9 @@ and want to launch a single Jupyter Notebook server in a container.
The [User Guide on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/) describes additional uses and features in detail. The [User Guide on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/) describes additional uses and features in detail.
**Example 1:** This command pulls the `jupyter/scipy-notebook` image tagged `33add21fab64` from Docker Hub if it is not already present on the local host. **Example 1:** This command pulls the `jupyter/scipy-notebook` image tagged `33add21fab64` from Docker Hub if it is not already present on the local host.
It then starts a container running a Jupyter Notebook server and exposes the server on host port 8888. It then starts a container running a Jupyter Server and exposes the server on host port 8888.
The server logs appear in the terminal. The server logs appear in the terminal.
Visiting `http://<hostname>:8888/?token=<token>` in a browser loads the Jupyter Notebook dashboard page, Visiting `http://<hostname>:8888/?token=<token>` in a browser loads JupyterLab,
where `hostname` is the name of the computer running docker and `token` is the secret token printed in the console. where `hostname` is the name of the computer running docker and `token` is the secret token printed in the console.
The container remains intact for restart after the notebook server exits. The container remains intact for restart after the notebook server exits.
@@ -32,7 +32,7 @@ docker run -p 8888:8888 jupyter/scipy-notebook:33add21fab64
``` ```
**Example 2:** This command performs the same operations as **Example 1**, but it exposes the server on host port 10000 instead of port 8888. **Example 2:** This command performs the same operations as **Example 1**, but it exposes the server on host port 10000 instead of port 8888.
Visiting `http://<hostname>:10000/?token=<token>` in a browser loads Jupyter Notebook server, Visiting `http://<hostname>:10000/?token=<token>` in a browser loads JupyterLab,
where `hostname` is the name of the computer running docker and `token` is the secret token printed in the console. where `hostname` is the name of the computer running docker and `token` is the secret token printed in the console.
```bash ```bash
@@ -40,15 +40,15 @@ docker run -p 10000:8888 jupyter/scipy-notebook:33add21fab64
``` ```
**Example 3:** This command pulls the `jupyter/datascience-notebook` image tagged `33add21fab64` from Docker Hub if it is not already present on the local host. **Example 3:** This command pulls the `jupyter/datascience-notebook` image tagged `33add21fab64` from Docker Hub if it is not already present on the local host.
It then starts an _ephemeral_ container running a Jupyter Notebook server and exposes the server on host port 10000. It then starts an _ephemeral_ container running a Jupyter Server and exposes the server on host port 10000.
The command mounts the current working directory on the host as `/home/jovyan/work` in the container. The command mounts the current working directory on the host as `/home/jovyan/work` in the container.
The server logs appear in the terminal. The server logs appear in the terminal.
Visiting `http://<hostname>:10000/?token=<token>` in a browser loads JupyterLab, Visiting `http://<hostname>:10000/?token=<token>` in a browser loads JupyterLab,
where `hostname` is the name of the computer running docker and `token` is the secret token printed in the console. where `hostname` is the name of the computer running docker and `token` is the secret token printed in the console.
Docker destroys the container after notebook server exit, but any files written to `~/work` in the container remain intact on the host. Docker destroys the container after Jupyter Server exit, but any files written to `~/work` in the container remain intact on the host.
```bash ```bash
docker run --rm -p 10000:8888 -e -v "${PWD}":/home/jovyan/work jupyter/datascience-notebook:33add21fab64 docker run --rm -p 10000:8888 -v "${PWD}":/home/jovyan/work jupyter/datascience-notebook:33add21fab64
``` ```
## Contributing ## Contributing