Skip to content

Commit cb9e243

Browse files
committed
Add initial slidedeck and fix some typos
1 parent 838434c commit cb9e243

4 files changed

Lines changed: 15 additions & 10 deletions

File tree

docs/ci.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010

1111
**Continuous Integration (CI)** is a software development practice where developers frequently merge their code changes
1212
into a shared repository. Each time code is added or updated, automated processes build the application and run tests
13-
to verify that everything still works correctly. This verification workflow is exactly the process we went through in
14-
the last episode:
13+
to verify that everything still works correctly. A basic verification workflow is exactly the process we went
14+
through in the last episode:
1515

1616
* Prepare the environment
1717
* Build the application
@@ -58,7 +58,7 @@ and GitLab to make sure this is the case:
5858

5959
The [EESSI GitLab Component](https://gitlab.com/explore/catalog/eessi/gitlab-eessi) also exists, and this allows
6060
you to follow a very similar approach to that described
61-
here for GitHub. At the end of the episode we will provide the equivalent file needed to enable GitLab CI.
61+
here for GitHub. Near the end of the episode we will provide the equivalent file needed to enable GitLab CI.
6262

6363
The first thing we need to do is to translate our workflow into something that the workflow tool, GitHub Actions in
6464
this case, can understand. GitHub itself has
@@ -199,7 +199,7 @@ To github.com:vlad/cicd-demo.git
199199
* [new branch] add_ci_to_project -> add_ci_to_project
200200
...
201201
```
202-
(where `vlad` is replaced by your own GitHub user handle). Let's go ahead and create the pull request lile the text
202+
(where `vlad` is replaced by your own GitHub user handle). Let's go ahead and create the pull request like the text
203203
suggested by visiting the URL. Once we open the link, we can modify the title/description if we wish, but otherwise
204204
we can just go ahead and click "Create pull request".
205205

@@ -287,8 +287,8 @@ will become a green tick which indicates that our CI for the commit has passed.
287287

288288
### What happens when CI fails?
289289

290-
What does a failure look like in CI? From the previous episode, we know that if we do not load the `buildenv` module
291-
our tests should fail. Let's
290+
What does a real failure look like in CI? From the previous episode, we know that if we do not load the `buildenv`
291+
module our tests should fail. Let's
292292
construct that scenario, by commenting out the line that loads that module:
293293
```yaml title="ci.yml"
294294
--8<-- "scripts/ci-broken.yml"
@@ -301,7 +301,7 @@ git commit -m "Don't load buildenv, which should break our CI"
301301
git push origin add_ci_to_project
302302
```
303303

304-
Eventually, as expected, our CI will fail and we will get a red X beside our commit. We should also receive an email
304+
Eventually, as expected, our CI will fail and we will get a red `X` beside our commit. We should also receive an email
305305
notification that our CI has failed. Such notifications are a critical part of CI, the value of CI is not just that
306306
the tests run silently, but that we are made aware immediately when things go wrong.
307307

2.74 MB
Binary file not shown.

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ EESSI provides a shared, portable, and optimized software stack for scientific c
1414

1515
For those attending the live tutorial at ISC 2026, there is a [prepared environment](prepared-environment.md) available.
1616

17+
!!! note "Slidedeck for the ISC 2026 tutorial"
18+
19+
The slidedeck for the tutorial given at ISC 2026 is available:
20+
<a href="downloads/EESSI_tutorial_slides_ISC2026.pdf" download="EESSI_tutorial_slides_ISC2026.pdf">Download PDF</a>
21+
1722
1. [Introduction to EESSI](introduction.md)
1823
2. [Getting Access to EESSI](getting-access.md)
1924
3. [Using EESSI](usage.md)

docs/installing-on-top.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
EESSI is sometimes described as "container without a container runtime". What that means is that it effectively
1111
provides an alternative operating system to the native one without the need for something to negotiate between the two.
1212
When we are _consuming_ software from EESSI, there is no real way to see this. It is only when we try to use EESSI as a
13-
basis for building new sotware that we are exposed to the additional complexity that this can bring.
13+
basis for building new software that we are exposed to the additional complexity that this can bring.
1414

1515
## Building a software project
1616

@@ -149,8 +149,8 @@ $ module spider hdf5
149149
We can see there are multiple versions available, but which one do we choose? Our application doesn't specify a specific
150150
version so we just choose the latest, `HDF5/1.14.6-gompi-2025b`, for now.The actual version of HDF5 is given by the
151151
first part of `1.14.6-gompi-2025b`, in this case `1.14.6`; the final part `gompi-2025b` is related to the
152-
[toolchain concept inside EasyBuild](https://docs.easybuild.io/common-toolchains/) and we won't get into that here
153-
since it is not the purpose of the tutorial.
152+
[toolchain concept used by EasyBuild](https://docs.easybuild.io/common-toolchains/). We won't dive into that toolchain
153+
concept here since it is not the purpose of the tutorial.
154154

155155
Having chose to try out `HDF5/1.14.6-gompi-2025b`, we can now load the module to make HDF5 available:
156156
``` { .bash .copy}

0 commit comments

Comments
 (0)