Skip to content

Commit 342a08e

Browse files
committed
Fix more minor typos
1 parent d43e9f4 commit 342a08e

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Jupyter Docker Stacks
22

3-
[![GitHub actions badge](https://github.com/jupyter/docker-stacks/actions/workflows/docker.yml/badge.svg)](https://github.com/jupyter/docker-stacks/actions/workflows/docker.yml?query=branch%3Amain "Docker images build status")
3+
[![GitHub Actions badge](https://github.com/jupyter/docker-stacks/actions/workflows/docker.yml/badge.svg)](https://github.com/jupyter/docker-stacks/actions/workflows/docker.yml?query=branch%3Amain "Docker images build status")
44
[![Read the Docs badge](https://img.shields.io/readthedocs/jupyter-docker-stacks.svg)](https://jupyter-docker-stacks.readthedocs.io/en/latest/ "Documentation build status")
55
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/jupyter/docker-stacks/main.svg)](https://results.pre-commit.ci/latest/github/jupyter/docker-stacks/main "pre-commit.ci build status")
66
[![Discourse badge](https://img.shields.io/discourse/users.svg?color=%23f37626&server=https%3A%2F%2Fdiscourse.jupyter.org)](https://discourse.jupyter.org/ "Jupyter Discourse Forum")

docs/contributing/stacks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ git push -u origin main
7171

7272
1. By default, the newly `.github/workflows/docker.yaml` will trigger the CI pipeline whenever you push to your `main` branch
7373
and when any Pull Requests are made to your repository.
74-
For more details on this configuration, visit the [GitHub actions documentation on triggers](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows).
74+
For more details on this configuration, visit the [GitHub Actions documentation on triggers](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows).
7575

7676
2. Go to your repository and click on the **Actions** tab.
7777
From there, you can click on the workflows on the left-hand side of the screen.

docs/maintaining/tagging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The prefix of commit hash (namely, 12 letters) is used as an image tag to make i
4646

4747
### Tagger
4848

49-
`Tagger` is a class that can be run inside a docker container to calculate some tag for an image.
49+
`Tagger` is a class that can be run inside a docker container to calculate a tag for an image.
5050

5151
All the taggers are inherited from `TaggerInterface`:
5252

@@ -91,6 +91,6 @@ and `markdown_piece(container)` method returns a piece of the build manifest.
9191

9292
## Images Hierarchy
9393

94-
All images' dependencies on each other and what taggers and manifest are applicable to them are defined in `hierarchy/images_hierarchy.py`.
94+
All images' dependencies on each other and what taggers and manifests are applicable to them are defined in `hierarchy/images_hierarchy.py`.
9595

9696
`hierarchy/get_taggers_and_manifests.py` defines a function to get the taggers and manifests for a specific image.

docs/maintaining/tasks.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ To build new images and publish them to the Registry, do the following:
1010

1111
```{note}
1212
GitHub Actions are pretty reliable, so please investigate if some error occurs.
13-
Building Docker images in PRs is the same as building them in the default branch,
14-
except single-platform images are pushed to Registry and then tags are merged for `x86_64` and `aarch64`.
13+
Building Docker images in PRs is the same as building them in the default branch.
14+
The only difference is that single-platform images are pushed to Registry and then tags are merged for `x86_64` and `aarch64`.
1515
```
1616

1717
4. Avoid merging another PR to the main branch until all pending builds in the main branch are complete.
@@ -29,12 +29,12 @@ When a new `Python` version is released, we wait for:
2929
## Updating the Ubuntu Base Image
3030

3131
`jupyter/docker-stacks-foundation` is based on the LTS Ubuntu docker image.
32-
We are waiting for the first point release of the new LTS Ubuntu before updating the version.
33-
Other images are directly or indirectly inherited from `docker-stacks-foundation`.
32+
We wait for the first point release of the new LTS Ubuntu before updating the version.
33+
Other images are directly or indirectly inherited from `jupyter/docker-stacks-foundation`.
3434
We rebuild our images automatically each week, which means they frequently receive updates.
3535

3636
When there's a security fix in the Ubuntu base image, it's a good idea to manually trigger the rebuild of images
37-
[from the GitHub actions workflow UI](https://github.com/jupyter/docker-stacks/actions/workflows/docker.yml).
37+
[from the GitHub Actions workflow UI](https://github.com/jupyter/docker-stacks/actions/workflows/docker.yml).
3838
Pushing the `Run Workflow` button will trigger this process.
3939

4040
## Adding a New Core Image to the Registry
@@ -67,5 +67,5 @@ When there's a new stack definition, check before merging the PR:
6767

6868
## Restarting a failed build
6969

70-
If an automated build in GitHub Actions has got you down, you can restart failed steps on GitHub.
70+
If an automated build in GitHub Actions fails, you can restart the failed jobs on GitHub.
7171
You can also download the artifacts and investigate them for any issues.

0 commit comments

Comments
 (0)