Skip to content

Commit

Permalink
fixes spelling errors
Browse files Browse the repository at this point in the history
  • Loading branch information
fherreazcue committed Oct 24, 2024
1 parent b9a1c48 commit d3f8978
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 11 deletions.
6 changes: 3 additions & 3 deletions code/SPUC/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This image provides a service with which you can register space purple unicorn s
## Running the service
To start the service run:
```
docker run -p 8321:8321 fcoherreazcue/spuc:latest
docker run -p 8321:8321 spuacv/spuc:latest
```

## Registering a sighting
Expand All @@ -42,7 +42,7 @@ curl -X PUT localhost:8321/unicorn_spotted?location=moon\&brightness=100
will register a unicorn sighting on the moon with a brightness of 100iuhc.

The default behaviour is to set *Imperial Unicorn Hoove Candles* [iuhc],
but it can be configured to use *Intergalactic Unicorn Luminiocity Units* [iulu].
but it can be configured to use *Intergalactic Unicorn Luminosity Units* [iulu].

## Output configuration
The running container will confirm the sighting record with a print output.
Expand All @@ -64,7 +64,7 @@ curl localhost:8321/export

## Changing units

The brightness units can be changed from Imperial Unicorn Hoove Candles (iuhc) to Intergalactic Unicorn Luminiocity Units (iulu)
The brightness units can be changed from Imperial Unicorn Hoove Candles (iuhc) to Intergalactic Unicorn Luminosity Units (iulu)
by passing the parameters `--units iuhc` on container startup.

## Plugins
Expand Down
2 changes: 1 addition & 1 deletion code/SPUC/spuc.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ def unicorn_sighting() -> dict:
if units == "iuhc":
unit_long_name = "Imperial Unicorn Hoove Candles"
elif units == "iulu":
unit_long_name = "Intergalactic Unicorn Luminiocity Units"
unit_long_name = "Intergalactic Unicorn Luminosity Units"

# Print the initialization message
print(s.logo())
Expand Down
3 changes: 2 additions & 1 deletion code/SPUCSVi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ Simply fill and submit the form and continue your search for these fantastic cre

## Running the service

This image is intended to be used in conjunction with the Space Purple Unicorn Counter (SPUC) image.
This image is intended to be used in conjunction with the Space Purple Unicorn Counter (SPUC)
[image](https://hub.docker.com/r/spuacv/spuc).

Set the `SPUC_HOST` environment variable to the address of the SPUC service.

Expand Down
2 changes: 1 addition & 1 deletion episodes/docker-cli-toolkit.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Let's dive into the structure of the command we looked at. Here is a diagram whi
* Followed by the action to perform and the name of the object (e.g. run, pull)
* You can also include additional arguments and switches as needed (e.g. the image name)

But wait! We ran `docker pull spaucv/spuc:latest`, and the diagram shows the command as 'image'!
But wait! We ran `docker pull spuacv/spuc:latest`, and the diagram shows the command as 'image'!

We apologise for the trick but we were actually using a shorthand built into the Docker CLI.
There are a few of these shortcuts; they are useful, but can be confusing.
Expand Down
2 changes: 1 addition & 1 deletion episodes/docker-compose.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ docker compose logs
```output
[...]
spuc_container |
spuc_container | :::: Units set to Intergalactic Unicorn Luminiocity Units [iulu] ::::
spuc_container | :::: Units set to Intergalactic Unicorn Luminosity Units [iulu] ::::
spuc_container |
[...]
```
Expand Down
2 changes: 1 addition & 1 deletion episodes/docker-hub.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Although many of the containers made for docker are hosted in the Docker Hub, th
- [Artifact Registry](https://cloud.google.com/artifact-registry) from Google.
- [GLR](https://docs.gitlab.com/ee/user/packages/container_registry/) from GitLab.
- [ECR](https://aws.amazon.com/ecr/) from Amazon.
- [ACR](https://azure.microsoft.com/en-us/products/container-registry) from Azuere, Microsoft.
- [ACR](https://azure.microsoft.com/en-us/products/container-registry) from Azure, Microsoft.

::::::::::::::::::::::::::::::::::::::::::::::::::

Expand Down
4 changes: 2 additions & 2 deletions episodes/docker-run-configuration.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ This is the case for the brightness units in the SPUC container.

It is actually probably the first change you'd want to do to this particular container.
It is recording the brightness of the unicorns in *Imperial Unicorn Hoove Candles* (iuhc)!
This is a very outdated unit and we **must** change it to the much more standard *Intergalactic Unicorn Luminiocity Units* (iulu).
This is a very outdated unit and we **must** change it to the much more standard *Intergalactic Unicorn Luminosity Units* (iulu).

Fortunately the SPUC documentations tells us that we can pass a parameter to the container to set these units right.
If we look carefully at the entrypoint and command of the container, we can see that the default units are set to `iuhc` there:
Expand Down Expand Up @@ -138,7 +138,7 @@ count,time,location,brightness,units
4,2024-10-16 10:53:13.449393,jupyter,100,iuhc
5,2024-10-16 12:49:52.512391,jupyter,100,iuhc
6,2024-10-16 12:50:10.581131,jupyter,100,iuhc
7,2024-10-16 12:53:51.726902,vennus,148,iuhc
7,2024-10-16 12:53:51.726902,venus,148,iuhc
```

Finally, we have the correct units for the brightness of the unicorns!
Expand Down
2 changes: 1 addition & 1 deletion episodes/dockerfiles.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ docker run --rm --name spuc-stats_container -p 8321:8321 -v spuc-volume:/spuc/ou
=> CACHED [4/4] COPY print.config /spuc/config/print.config 0.0s
=> exporting to image 0.0s
[...]
:::: Units set to Intergalactic Unicorn Luminiocity Units [iulu] ::::
:::: Units set to Intergalactic Unicorn Luminosity Units [iulu] ::::
[...]
```

Expand Down

0 comments on commit d3f8978

Please sign in to comment.