hazza/docker-stacks
1
0
Fork 0
mirror of https://github.com/jupyter/docker-stacks.git synced 2025-10-07 18:14:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix more errors

Browse Source
This commit is contained in:
Ayaz Salikhov
2021-05-01 13:07:40 +03:00
parent bf5ec600d1
commit c2031e2a4a
18 changed files with 34 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE.md
View File

@@ -39,7 +39,7 @@ The Jupyter Development Team is the set of all contributors to the Jupyter proje
This includes all of the Jupyter subprojects.
The core team that coordinates development on GitHub can be found here:
https://github.com/jupyter/.
<https://github.com/jupyter/>.
## Our Copyright Policy

2
all-spark-notebook/README.md
View File

@@ -4,7 +4,7 @@
[![docker stars](https://img.shields.io/docker/stars/jupyter/all-spark-notebook.svg)](https://hub.docker.com/r/jupyter/all-spark-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/all-spark-notebook.svg)](https://microbadger.com/images/jupyter/all-spark-notebook "jupyter/all-spark-notebook image metadata")
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
to Docker Hub.
Please visit the project documentation site for help using and contributing to this image and

2
base-notebook/README.md
View File

@@ -4,7 +4,7 @@
[![docker stars](https://img.shields.io/docker/stars/jupyter/base-notebook.svg)](https://hub.docker.com/r/jupyter/base-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/base-notebook.svg)](https://microbadger.com/images/jupyter/base-notebook "jupyter/base-notebook image metadata")
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
to Docker Hub.
Please visit the project documentation site for help using and contributing to this image and

2
datascience-notebook/README.md
View File

@@ -4,7 +4,7 @@
[![docker stars](https://img.shields.io/docker/stars/jupyter/datascience-notebook.svg)](https://hub.docker.com/r/jupyter/datascience-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/datascience-notebook.svg)](https://microbadger.com/images/jupyter/datascience-notebook "jupyter/datascience-notebook image metadata")
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
to Docker Hub.
Please visit the project documentation site for help using and contributing to this image and

10
docs/contributing/lint.md
View File

@@ -6,7 +6,7 @@ To integrate and enforce this process in the project lifecycle we are using **gi
## Pre-commit hook
### Installation
### Pre-commit hook installation
pre-commit is a Python package that needs to be installed.
This can be achieved by using the generic task used to install all Python development dependencies.
@@ -21,7 +21,7 @@ $ pip install pre-commit
Then the git hooks scripts configured for the project in `.pre-commit-config.yaml` need to be installed in the local git repository.
```sh
$ make pre-commit-install
make pre-commit-install
```
### Run
@@ -30,14 +30,14 @@ Now pre-commit (and so configured hooks) will run automatically on `git commit`
However it is also possible to trigger it against all files.
```sh
$ make pre-commit-all
make pre-commit-all
```
## Image Lint
To comply with [Docker best practices][dbp], we are using the [Hadolint][hadolint] tool to analyse each `Dockerfile` .
### Installation
### Hadolint installation
There is a specific `make` target to install the linter.
By default `hadolint` will be installed in `${HOME}/hadolint`.
@@ -81,7 +81,7 @@ $ make hadolint/scipy-notebook ARGS="--format codeclimate"
The linter can be run against all the stacks.
```bash
$ make hadolint-all
make hadolint-all
```
### Ignoring Rules

2
docs/contributing/translations.md
View File

@@ -3,5 +3,5 @@
We are delighted when members of the Jupyter community want to help translate these documentation pages to other languages. If you're interested, please visit links below below to join our team on [Transifex](https://transifex.com) and to start creating, reviewing, and updating translations of the Jupyter Docker Stacks documentation.
1. Follow the steps documented on the [Getting Started as a Translator](https://docs.transifex.com/getting-started-1/translators) page.
2. Look for *jupyter-docker-stacks* when prompted to choose a translation team. Alternatively, visit https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1 after creating your account and request to join the project.
2. Look for *jupyter-docker-stacks* when prompted to choose a translation team. Alternatively, visit <https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1> after creating your account and request to join the project.
3. See [Translating with the Web Editor](https://docs.transifex.com/translation/translating-with-the-web-editor) in the Transifex documentation.

2
docs/locale/en/LC_MESSAGES/maintaining.po
View File

@@ -283,7 +283,7 @@ msgstr ""
# 2869b2f7a89c428f903e3695dd511e9a
#: ../../maintaining/tasks.md:92 9ebca91beff846648bdc758fc90afec1
msgid "Enter https://github.com/jupyter/docker-stacks for the URL."
msgid "Enter <https://github.com/jupyter/docker-stacks> for the URL."
msgstr ""
#: ../../maintaining/tasks.md:93 2d3b518fd69640169e17d44018a7a8e4

12
docs/maintaining/tasks.md
View File

@@ -62,9 +62,9 @@ When there's a new stack definition, do the following before merging the PR with
## Adding a New Maintainer Account
1. Visit https://cloud.docker.com/app/jupyter/team/stacks/users
1. Visit <https://cloud.docker.com/app/jupyter/team/stacks/users>
2. Add the maintainer's Docker Cloud username.
3. Visit https://github.com/orgs/jupyter/teams/docker-image-maintainers/members
3. Visit <https://github.com/orgs/jupyter/teams/docker-image-maintainers/members>
4. Add the maintainer's GitHub username.
## Pushing a Build Manually
@@ -80,16 +80,16 @@ If automated builds on Docker Cloud have got you down, do the following to push
First enable translation on Transifex:
1. Visit https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1/languages/
1. Visit <https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1/languages/>.
2. Click _Edit Languages_ in the top right.
3. Select the language from the dropdown.
4. Click _Apply_.
Then setup a subproject on ReadTheDocs for the language:
1. Visit https://readthedocs.org/dashboard/import/manual/
1. Visit <https://readthedocs.org/dashboard/import/manual/>.
2. Enter _jupyter-docker-stacks-language_abbreviation_ for the project name.
3. Enter https://github.com/jupyter/docker-stacks for the URL.
3. Enter <https://github.com/jupyter/docker-stacks> for the URL.
4. Check _Edit advanced project options_.
5. Click _Next_.
6. Select the _Language_ from the dropdown on the next screen.
@@ -97,6 +97,6 @@ Then setup a subproject on ReadTheDocs for the language:
Finally link the new language subproject to the top level doc project:
1. Visit https://readthedocs.org/dashboard/jupyter-docker-stacks/translations/
1. Visit <https://readthedocs.org/dashboard/jupyter-docker-stacks/translations/>.
2. Select the subproject you created from the _Project_ dropdown.
3. Click _Add_.

2
docs/using/running.md
View File

@@ -96,7 +96,7 @@ docker logs --tail 3 notebook
http://localhost:8888/?token=15914ca95f495075c0aa7d0e060f1a78b6d94f70ea373b00
```
Together, the URL to visit on the host machine to access the server in this case is http://localhost:32769?token=15914ca95f495075c0aa7d0e060f1a78b6d94f70ea373b00.
Together, the URL to visit on the host machine to access the server in this case is <http://localhost:32769?token=15914ca95f495075c0aa7d0e060f1a78b6d94f70ea373b00>.
The container runs in the background until stopped and/or removed by additional Docker commands.

14
docs/using/specifics.md
View File

@@ -52,7 +52,7 @@ The `jupyter/pyspark-notebook` and `jupyter/all-spark-notebook` images support t
Spark **local mode** is useful for experimentation on small data when you do not have a Spark cluster available.
##### In Python
##### Local Mode in Python
In a Python notebook.
@@ -69,7 +69,7 @@ rdd.sum()
# 5050
```
##### In R
##### Local Mode in R
In a R notebook with [SparkR][sparkr].
@@ -107,7 +107,7 @@ sdf_len(sc, 100, repartition = 1) %>%
# 5050
```
##### In Scala
##### Local Mode in Scala
Spylon kernel instantiates a `SparkContext` for you in variable `sc` after you configure Spark
options in a `%%init_spark` magic cell.
@@ -136,11 +136,11 @@ Connection to Spark Cluster on **[Standalone Mode](https://spark.apache.org/docs
your Spark workers. (This is a [Spark networking
requirement](http://spark.apache.org/docs/latest/cluster-overview.html#components).)
* NOTE: When using `--net=host`, you must also use the flags `--pid=host -e
TINI_SUBREAPER=true`. See https://github.com/jupyter/docker-stacks/issues/64 for details.
TINI_SUBREAPER=true`. See <https://github.com/jupyter/docker-stacks/issues/64> for details.
**Note**: In the following examples we are using the Spark master URL `spark://master:7077` that shall be replaced by the URL of the Spark master.
##### In Python
##### Standalone Mode in Python
The **same Python version** need to be used on the notebook (where the driver is located) and on the Spark workers.
The python version used at driver and worker side can be adjusted by setting the environment variables `PYSPARK_PYTHON` and / or `PYSPARK_DRIVER_PYTHON`, see [Spark Configuration][spark-conf] for more information.
@@ -158,7 +158,7 @@ rdd.sum()
# 5050
```
##### In R
##### Standalone Mode in R
In a R notebook with [SparkR][sparkr].
@@ -195,7 +195,7 @@ sdf_len(sc, 100, repartition = 1) %>%
# 5050
```
##### In Scala
##### Standalone Mode in Scala
Spylon kernel instantiates a `SparkContext` for you in variable `sc` after you configure Spark
options in a `%%init_spark` magic cell.

6
examples/docker-compose/README.md
View File

@@ -34,7 +34,6 @@ To stop and remove the container:
notebook/down.sh
```
## FAQ
### How do I specify which docker-stack notebook image to deploy?
@@ -75,7 +74,6 @@ NAME=your-notebook notebook/down.sh
The `up.sh` creates a Docker volume named after the notebook container with a `-work` suffix, e.g., `my-notebook-work`.
### Can multiple notebook containers share the same notebook volume?
Yes. Set the `WORK_VOLUME` environment variable to the same value for each notebook.
@@ -100,7 +98,6 @@ 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.
The following command will create a certificate chain and store it in a Docker volume named `mydomain-secrets`.
@@ -154,10 +151,9 @@ bin/softlayer.sh myhost
bin/sl-dns.sh myhost
```
## Troubleshooting
### Unable to connect to VirtualBox VM on Mac OS X when using Cisco VPN client.
### Unable to connect to VirtualBox VM on Mac OS X when using Cisco VPN client
The Cisco VPN client blocks access to IP addresses that it does not know about, and may block access to a new VM if it is created while the Cisco VPN client is running.

2
examples/make-deploy/README.md
View File

@@ -5,7 +5,7 @@ This folder contains a Makefile and a set of supporting files demonstrating how
## Prerequisites
* make 3.81+
* Ubuntu users: Be aware of [make 3.81 defect 483086](https://bugs.launchpad.net/ubuntu/+source/make-dfsg/+bug/483086) which exists in 14.04 LTS but is fixed in 15.04+
* Ubuntu users: Be aware of [make 3.81 defect 483086](https://bugs.launchpad.net/ubuntu/+source/make-dfsg/+bug/483086) which exists in 14.04 LTS but is fixed in 15.04+
* docker-machine 0.5.0+
* docker 1.9.0+

4
examples/source-to-image/README.md
View File

@@ -7,7 +7,7 @@ The build scripts, when used with the Source-to-Image tool, provide similar capa
For separate examples of using JupyterHub with OpenShift, see the project:
* https://github.com/jupyter-on-openshift/jupyterhub-quickstart
* <https://github.com/jupyter-on-openshift/jupyterhub-quickstart>
Source-to-Image Project
-----------------------
@@ -16,7 +16,7 @@ Source-to-Image (S2I) is an open source project which provides a tool for creati
Details on the S2I tool, and executable binaries for Linux, macOS and Windows, can be found on GitHub at:
* https://github.com/openshift/source-to-image
* <https://github.com/openshift/source-to-image>
The tool is standalone, and can be used on any system which provides a docker daemon for running containers. To provide an end-to-end capability to build and deploy applications in containers, support for S2I is also integrated into container platforms such as OpenShift.

2
minimal-notebook/README.md
View File

@@ -4,7 +4,7 @@
[![docker stars](https://img.shields.io/docker/stars/jupyter/minimal-notebook.svg)](https://hub.docker.com/r/jupyter/minimal-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/minimal-notebook.svg)](https://microbadger.com/images/jupyter/minimal-notebook "jupyter/minimal-notebook image metadata")
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
to Docker Hub.
Please visit the project documentation site for help using and contributing to this image and

2
pyspark-notebook/README.md
View File

@@ -4,7 +4,7 @@
[![docker stars](https://img.shields.io/docker/stars/jupyter/pyspark-notebook.svg)](https://hub.docker.com/r/jupyter/pyspark-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/pyspark-notebook.svg)](https://microbadger.com/images/jupyter/pyspark-notebook "jupyter/pyspark-notebook image metadata")
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
to Docker Hub.
Please visit the project documentation site for help using and contributing to this image and

2
r-notebook/README.md
View File

@@ -4,7 +4,7 @@
[![docker stars](https://img.shields.io/docker/stars/jupyter/r-notebook.svg)](https://hub.docker.com/r/jupyter/r-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/r-notebook.svg)](https://microbadger.com/images/jupyter/r-notebook "jupyter/r-notebook image metadata")
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
to Docker Hub.
Please visit the project documentation site for help using and contributing to this image and

2
scipy-notebook/README.md
View File

@@ -4,7 +4,7 @@
[![docker stars](https://img.shields.io/docker/stars/jupyter/scipy-notebook.svg)](https://hub.docker.com/r/jupyter/scipy-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/scipy-notebook.svg)](https://microbadger.com/images/jupyter/scipy-notebook "jupyter/scipy-notebook image metadata")
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
to Docker Hub.
Please visit the project documentation site for help using and contributing to this image and

2
tensorflow-notebook/README.md
View File

@@ -4,7 +4,7 @@
[![docker stars](https://img.shields.io/docker/stars/jupyter/tensorflow-notebook.svg)](https://hub.docker.com/r/jupyter/tensorflow-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/tensorflow-notebook.svg)](https://microbadger.com/images/jupyter/tensorflow-notebook "jupyter/tensorflow-notebook image metadata")
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
to Docker Hub.
Please visit the project documentation site for help using and contributing to this image and