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

Apply suggestions from code review

Browse Source 
Co-authored-by: Tania Allard <taniar.allard@gmail.com>
This commit is contained in:
Ayaz Salikhov
2022-02-02 16:18:28 +03:00
committed by GitHub
parent 359a660570
commit 9fa1a586fc
4 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/contributing/features.md
View File

@@ -39,7 +39,7 @@ If there's agreement that the feature belongs in one or more of the core stacks:
1. Implement the feature in a local clone of the `jupyter/docker-stacks` project. 1. Implement the feature in a local clone of the `jupyter/docker-stacks` project.
2. Please, build the image locally before submitting a pull request. 2. Please, build the image locally before submitting a pull request.
It shortens the debugging cycle by taking some load off GitHub Actions, It shortens the debugging cycle by taking some load off GitHub Actions,
which graciously provide free build services for open source projects like this one. which graciously provides free build services for open source projects like this one.
If you use `make`, call: If you use `make`, call:
```bash ```bash

2
docs/contributing/packages.md
View File

@@ -6,7 +6,7 @@ This means that packages might have old versions.
Images are rebuilt weekly, so usually, packages receive updates quite frequently. Images are rebuilt weekly, so usually, packages receive updates quite frequently.
```{note} ```{note}
We pin major.minor version of python, so it will stay the same even after `mamba update` command. We pin major.minor version of python, so this will stay the same even after invoking the `mamba update` command.
``` ```
## Outdated packages ## Outdated packages

4
docs/contributing/tests.md
View File

@@ -15,8 +15,8 @@ defined in the [conftest.py](https://github.com/jupyter/docker-stacks/blob/maste
## Unit tests ## Unit tests
If you want to simply run a python script in one of our images, you could add a unit test. If you want to run a python script in one of our images, you could add a unit test.
Simply create `<somestack>-notebook/test/units/` directory, if it doesn't already exist and put your file there. You can do this by creating a `<somestack>-notebook/test/units/` directory, if it doesn't already exist and put your file there.
These file will run automatically when tests are run. These file will run automatically when tests are run.
You could see an example for tensorflow package [here](https://github.com/jupyter/docker-stacks/blob/HEAD/tensorflow-notebook/test/units/unit_tensorflow.py). You could see an example for tensorflow package [here](https://github.com/jupyter/docker-stacks/blob/HEAD/tensorflow-notebook/test/units/unit_tensorflow.py).

2
docs/maintaining/tasks.md
View File

@@ -18,7 +18,7 @@ To build new images and publish them to the Docker Hub registry, do the followin
Other images are directly or indirectly inherited from `minimal-notebook`. Other images are directly or indirectly inherited from `minimal-notebook`.
We rebuild our images automatically each week, which means they receive the updates quite frequently. We rebuild our images automatically each week, which means they receive the updates quite frequently.
When there's a security fix in the Ubuntu base image, it's a good idea to manually trigger images rebuild [here](https://github.com/jupyter/docker-stacks/actions/workflows/docker.yml). When there's a security fix in the Ubuntu base image, it's a good idea to manually trigger images rebuild [from the GitHub actions workflow UI](https://github.com/jupyter/docker-stacks/actions/workflows/docker.yml).
Pushing `Run Workflow` button will trigger this process. Pushing `Run Workflow` button will trigger this process.
## Adding a New Core Image to Docker Hub ## Adding a New Core Image to Docker Hub