Skip to content

Commit

Permalink
Fix more minor typos
Browse files Browse the repository at this point in the history
  • Loading branch information
mathbunnyru committed Mar 3, 2025
1 parent d43e9f4 commit 342a08e
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Jupyter Docker Stacks

[![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")
[![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")
[![Read the Docs badge](https://img.shields.io/readthedocs/jupyter-docker-stacks.svg)](https://jupyter-docker-stacks.readthedocs.io/en/latest/ "Documentation build status")
[![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")
[![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")
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/stacks.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ git push -u origin main

1. By default, the newly `.github/workflows/docker.yaml` 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/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows).
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).

2. Go to your repository and click on the **Actions** tab.
From there, you can click on the workflows on the left-hand side of the screen.
Expand Down
4 changes: 2 additions & 2 deletions docs/maintaining/tagging.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The prefix of commit hash (namely, 12 letters) is used as an image tag to make i

### Tagger

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

All the taggers are inherited from `TaggerInterface`:

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

## Images Hierarchy

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

`hierarchy/get_taggers_and_manifests.py` defines a function to get the taggers and manifests for a specific image.
12 changes: 6 additions & 6 deletions docs/maintaining/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ To build new images and publish them to the Registry, do the following:

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

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

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

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

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

## Restarting a failed build

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

0 comments on commit 342a08e

Please sign in to comment.