diff --git a/docs/contributing/features.md b/docs/contributing/features.md index 5b048905..a313493d 100644 --- a/docs/contributing/features.md +++ b/docs/contributing/features.md @@ -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. 2. Please, build the image locally before submitting a pull request. 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: ```bash diff --git a/docs/contributing/packages.md b/docs/contributing/packages.md index 338e9563..568ad94a 100644 --- a/docs/contributing/packages.md +++ b/docs/contributing/packages.md @@ -6,7 +6,7 @@ This means that packages might have old versions. Images are rebuilt weekly, so usually, packages receive updates quite frequently. ```{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 diff --git a/docs/contributing/tests.md b/docs/contributing/tests.md index 24d1b628..a0157e4c 100644 --- a/docs/contributing/tests.md +++ b/docs/contributing/tests.md @@ -15,8 +15,8 @@ defined in the [conftest.py](https://github.com/jupyter/docker-stacks/blob/maste ## Unit tests -If you want to simply run a python script in one of our images, you could add a unit test. -Simply create `-notebook/test/units/` directory, if it doesn't already exist and put your file there. +If you want to run a python script in one of our images, you could add a unit test. +You can do this by creating a `-notebook/test/units/` directory, if it doesn't already exist and put your file there. 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). diff --git a/docs/maintaining/tasks.md b/docs/maintaining/tasks.md index fcb40b89..f490bc2a 100644 --- a/docs/maintaining/tasks.md +++ b/docs/maintaining/tasks.md @@ -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`. 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. ## Adding a New Core Image to Docker Hub