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

Fix grammar

Browse Source
This commit is contained in:
Ayaz Salikhov
2023-02-16 11:25:10 +04:00
parent db35f7652a
commit d3a9357e68
10 changed files with 24 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/contributing/lint.md
View File

@@ -1,6 +1,6 @@
# Lint
To enforce some rules **linters** are used in this project.
To enforce some rules, **linters** are used in this project.
Linters can be run either during the **development phase** (by the developer) or the **integration phase** (by GitHub Actions).
To integrate and enforce this process in the project lifecycle, we are using **git hooks** through [pre-commit][pre-commit].

4
docs/contributing/packages.md
View File

@@ -12,8 +12,8 @@ We pin major.minor version of python, so this will stay the same even after invo
## Outdated packages
To help to identify packages that can be updated, you can use the following helper tool.
It will list all the packages installed in the `Dockerfile` that can be updated -- dependencies are
filtered to focus only on requested packages.
It will list all the updateable packages installed in the `Dockerfile` --
dependencies are filtered to focus only on requested packages.
```bash
make check-outdated/base-notebook

2
docs/contributing/recipes.md
View File

@@ -1,6 +1,6 @@
# New Recipes
We welcome contributions of [recipes](../using/recipes.md), short examples of using, configuring, or extending the Docker Stacks, for inclusion in the documentation site.
We welcome contributions of [recipes](../using/recipes.md), short examples of using, configuring, or extending the Docker Stacks for inclusion in the documentation site.
Follow the process below to add a new recipe:
1. Open the `docs/using/recipes.md` source file.

14
docs/contributing/stacks.md
View File

@@ -87,17 +87,17 @@ The cookiecutter template comes with a `.github/workflows/docker.yml` file, whic
This will trigger the CI pipeline whenever you push to your `main` branch and when any Pull Requests are made to your repository.
For more details on this configuration, visit the [GitHub actions documentation on triggers](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows).
2. Commit your changes and push to GitHub.
2. Commit your changes and push them to GitHub.
3. Head back to your repository and click on the **Actions** tab.
![GitHub page for jupyter/docker-stacks with the Actions tab active and a rectangle around the "Build Docker Images" workflow in the UI](../_static/github-actions-tab.png)
From there, you can click on the workflows on the left-hand side of the screen.
4. In the next screen, you will see information about the workflow run and duration.
If you click again on the button with the workflow name, you will see the logs for the workflow steps.
If you click the button with the workflow name again, you will see the logs for the workflow steps.
![GitHub Actions page showing the "Build Docker Images" workflow](../_static/github-actions-workflow.png)
## Configuring Docker Hub
Now, configure Docker Hub to build your stack image and push it to Docker Hub repository whenever
Now, configure Docker Hub to build your stack image and push it to the Docker Hub repository whenever
you merge a GitHub pull request to the main branch of your project.
1. Visit [https://hub.docker.com/](https://hub.docker.com/) and log in.
@@ -124,7 +124,7 @@ you merge a GitHub pull request to the main branch of your project.
```
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)
![GitHub page with 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 in the top right corner (see image above).
15. Create a **DOCKERHUB_TOKEN** secret and paste the Personal Access Token from DockerHub in the **value** field.
![GitHub - Actions/New secret page with the Name field set to "DOCKERHUB_TOKEN"](../_static/github-secret-token.png)
@@ -137,12 +137,12 @@ you merge a GitHub pull request to the main branch of your project.
Make edits to the Dockerfile in your project to add third-party libraries and configure Jupyter
applications.
Refer to the Dockerfiles for the core stacks (e.g., [jupyter/datascience-notebook](https://github.com/jupyter/docker-stacks/blob/main/datascience-notebook/Dockerfile))
to get a feel for what's possible and best practices.
to get a feel for what's possible and the best practices.
[Submit pull requests](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)
to your project repository on GitHub.
Ensure your image builds correctly on GitHub actions before merging to main branch.
Refer to Docker Hub to build your main branch that you can `docker pull`.
Ensure your image builds correctly on GitHub actions before merging to the main branch.
Refer to Docker Hub to build the main branch that you can `docker pull`.
## Sharing Your Image

2
docs/contributing/tests.md
View File

@@ -7,7 +7,7 @@ We greatly appreciate pull requests that extend the automated tests that vet the
A [GitHub Action workflow](https://github.com/jupyter/docker-stacks/blob/main/.github/workflows/docker.yml)
runs tests against pull requests submitted to the `jupyter/docker-stacks` repository.
We use `pytest` module to run tests on the image.
We use the `pytest` module to run tests on the image.
`conftest.py` and `pytest.ini` in the `tests` folder define the environment in which tests are run.
More info on `pytest` can be found [here](https://docs.pytest.org/en/latest/contents.html).

2
docs/using/common.md
View File

@@ -12,7 +12,7 @@ You can pass [Jupyter server options](https://jupyter-server.readthedocs.io/en/l
1. For example, to secure the Notebook server with a [custom password](https://jupyter-server.readthedocs.io/en/latest/operators/public-server.html#preparing-a-hashed-password)
hashed using `jupyter_server.auth.security.passwd()` instead of the default token,
you can run the following (this hash was generated for `my-password` password):
you can run the following (this hash was generated for the `my-password` password):
```bash
docker run -it --rm -p 8888:8888 jupyter/base-notebook \

8
docs/using/recipes.md
View File

@@ -193,8 +193,8 @@ Sometimes it is helpful to run the Jupyter instance behind an nginx proxy, for e
- you would prefer to access the notebook at a server URL with a path
(`https://example.com/jupyter`) rather than a port (`https://example.com:8888`)
- you may have many services in addition to Jupyter running on the same server, and want
nginx to help improve server performance in managing the connections
- you may have many services in addition to Jupyter running on the same server
and want nginx to help improve server performance in managing the connections
Here is a [quick example of NGINX configuration](https://gist.github.com/cboettig/8643341bd3c93b62b5c2) to get started.
You'll need a server, a `.crt` and `.key` file for your server, and `docker` & `docker-compose` installed.
@@ -418,7 +418,7 @@ RUN echo 'deb https://cdn-fastly.deb.debian.org/debian jessie-backports main' >
# Alternatively, this could be mounted as a volume
rm -f /usr/local/hadoop-2.7.3/etc/hadoop/*
# Download this from ambari / cloudera manager and copy here
# Download this from ambari/cloudera manager and copy it here
COPY example-hadoop-conf/ /usr/local/hadoop-2.7.3/etc/hadoop/
# Spark-Submit doesn't work unless I set the following
@@ -558,7 +558,7 @@ RUN PYV=$(ls "${CONDA_DIR}/lib" | grep ^python) && \
It is not required on Windows and won't work on macOS.
```
To enable `pandas.read_clipboard()` functionality, you need to have `xclip` installed
To enable the `pandas.read_clipboard()` functionality, you need to have `xclip` installed
(installed in `minimal-notebook` and all the inherited images)
and add these options when running `docker`: `-e DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix`, i.e.:

4
docs/using/specifics.md
View File

@@ -164,7 +164,7 @@ Connection to Spark Cluster on **[Standalone Mode](https://spark.apache.org/docs
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._
```
**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.
**Note**: In the following examples, we are using the Spark master URL `spark://master:7077` which shall be replaced by the URL of the Spark master.
##### Standalone Mode in Python
@@ -246,7 +246,7 @@ spark = (
```
Dependencies can also be defined in the `spark-defaults.conf`.
However, it has to be done by `root` so it should only be considered to build custom images.
However, it has to be done by `root`, so it should only be considered to build custom images.
```dockerfile
USER root

7
docs/using/troubleshooting.md
View File

@@ -57,7 +57,7 @@ The following sections cover a few of these scenarios and how to fix them.
- `CHOWN_EXTRA_OPTS="-R"`: will recursively change the ownership and group of the directory specified in `CHOWN_EXTRA`.
- `--user root`: you **must** run the container with the root user to change ownership at runtime.
now accessing the mount should work as expected:
Now accessing the mount should work as expected:
```bash
# assuming we mounted the volume in /home/jovyan/stagingarea
@@ -130,7 +130,8 @@ If you have also **created a new user**, you might be experiencing any of the fo
1. **Ensure the new user has ownership of `/home` and volume mounts**
For example, say you want to create a user `callisto` with a `GID` and `UID` of `1234`, you will have to add the following flags to the docker run command:
For example, say you want to create a user `callisto` with a `GID` and `UID` of `1234`.
You will have to add the following flags to the docker run command:
```bash
docker run -it --rm \
@@ -323,6 +324,6 @@ If you are a regular user of VSCode and the Jupyter extension, you might experie
When the terminal provides the link to access Jupyter: <http://127.0.0.1:8888/lab?token=80d45d241a1ba4c2...>,
change the default port value of `8888` in the url to the port value mapped with the `docker run` command.
In this example we use 8001, so the edited link would be: <http://127.0.0.1:8001/lab?token=80d45d241a1ba4c2...>.
In this example, we use 8001, so the edited link would be: <http://127.0.0.1:8001/lab?token=80d45d241a1ba4c2...>.
Note: Port mapping for Jupyter has other applications outside of Docker. For example, it can be used to allow multiple Jupyter instances when using SSH to control cloud devices.