diff --git a/docs/contributing/stacks.md b/docs/contributing/stacks.md index 3d70a4b1..e31eda79 100644 --- a/docs/contributing/stacks.md +++ b/docs/contributing/stacks.md @@ -119,7 +119,11 @@ you merge a GitHub pull request to the master branch of your project. 11. Enter a meaningful name for your token and click on **Create** ![DockerHub - New Access Token page with the name field set to "my-jupyter-docker-token"](../_static/docker-org-create-token.png) 12. Copy the personal access token displayed on the next screen. - **Note that you will not be able to see it again after you close the pop-up window**. + + ```{note} + you will not be able to see it again after you close the pop-up window**. + ``` + 13. Head back to your GitHub repository and click on the **Settings tab**. ![GitHub page with the the "Setting" tab active and a rectangle highlighting the "New repository secret" button in the UI](../_static/github-create-secrets.png) 14. Click on the **Secrets** section and then on the **New repository secret** button on the top right corner (see image above). diff --git a/docs/using/common.md b/docs/using/common.md index b105dd10..6d395cf8 100644 --- a/docs/using/common.md +++ b/docs/using/common.md @@ -78,10 +78,13 @@ You do so by passing arguments to the `docker run` command. For example, if setting `umask` to `002`, new files will be readable and writable by group members instead of the owner only. [Check this Wikipedia article](https://en.wikipedia.org/wiki/Umask) for an in-depth description of `umask` and suitable values for multiple needs. While the default `umask` value should be sufficient for most use cases, you can set the `NB_UMASK` value to fit your requirements. - _Note that `NB_UMASK` when set only applies to the Jupyter process itself - + + ```{note} + `NB_UMASK` when set only applies to the Jupyter process itself - you cannot use it to set a `umask` for additional files created during run-hooks. For example, via `pip` or `conda`. If you need to set a `umask` for these, you must set the `umask` value for each command._ + ``` - `-e CHOWN_HOME=yes` - Instructs the startup script to change the `${NB_USER}` home directory owner and group to the current value of `${NB_UID}` and `${NB_GID}`. This change will take effect even if the user home directory is mounted from the host using `-v` as described below. diff --git a/docs/using/specifics.md b/docs/using/specifics.md index 17046898..7b425027 100644 --- a/docs/using/specifics.md +++ b/docs/using/specifics.md @@ -9,7 +9,11 @@ This page provides details about features specific to one or more images. - `-p 4040:4040` - The `jupyter/pyspark-notebook` and `jupyter/all-spark-notebook` images open [SparkUI (Spark Monitoring and Instrumentation UI)](https://spark.apache.org/docs/latest/monitoring.html) at default port `4040`, this option map `4040` port inside docker container to `4040` port on host machine. - Note every new spark context that is created is put onto an incrementing port (ie. 4040, 4041, 4042, etc.), and it might be necessary to open multiple ports. + + ```{note} + Every new spark context that is created is put onto an incrementing port (ie. 4040, 4041, 4042, etc.), and it might be necessary to open multiple ports. + ``` + For example: `docker run -d -p 8888:8888 -p 4040:4040 -p 4041:4041 jupyter/pyspark-notebook`. #### IPython low-level output capture and forward @@ -245,6 +249,10 @@ rdd.sum() ### Define Spark Dependencies +```{note} +This example is given for [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/hadoop/current/install.html). +``` + Spark dependencies can be declared thanks to the `spark.jars.packages` property (see [Spark Configuration](https://spark.apache.org/docs/latest/configuration.html#runtime-environment) for more information). @@ -274,8 +282,6 @@ USER ${NB_UID} Jars will be downloaded dynamically at the creation of the Spark session and stored by default in `${HOME}/.ivy2/jars` (can be changed by setting `spark.jars.ivy`). -_Note: This example is given for [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/hadoop/current/install.html)._ - ## Tensorflow The `jupyter/tensorflow-notebook` image supports the use of diff --git a/examples/docker-compose/README.md b/examples/docker-compose/README.md index 483fac07..b9b72208 100644 --- a/examples/docker-compose/README.md +++ b/examples/docker-compose/README.md @@ -102,7 +102,10 @@ notebook/up.sh --secure --password a_secret Sure. If you want to secure access to publicly addressable notebook containers, you can generate a free certificate using the [Let's Encrypt](https://letsencrypt.org) service. This example includes the `bin/letsencrypt.sh` script, which runs the `letsencrypt` client to create a full-chain certificate and private key, and stores them in a Docker volume. -_Note:_ The script hard codes several `letsencrypt` options, one of which automatically agrees to the Let's Encrypt Terms of Service. + +```{note} +The script hard codes several `letsencrypt` options, one of which automatically agrees to the Let's Encrypt Terms of Service. +``` The following command will create a certificate chain and store it in a Docker volume named `mydomain-secrets`.