Skip to content

Set of customization hooks for different topics#480

Open
mahermanns wants to merge 1 commit into
carpentries-incubator:mainfrom
HPC-NRW:feature-customization-hooks
Open

Set of customization hooks for different topics#480
mahermanns wants to merge 1 commit into
carpentries-incubator:mainfrom
HPC-NRW:feature-customization-hooks

Conversation

@mahermanns
Copy link
Copy Markdown
Contributor

The Introduction to HPC provides basic knowledge on how to navigate HPC systems.

At different times in the episodes it would be helpful to add local information to enable a "that is how it is in general --- this is how it is on the local platform" material.

This PR adds empty snippets to the default customization (HPCC_MagicCastle_Slurm) and integrates them into the episodes.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 5, 2026

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/carpentries-incubator/hpc-intro/compare/md-outputs..md-outputs-PR-480

The following changes were observed in the rendered markdown documents:

 10-hpc-intro.md                                    |   3 +
 11-connecting.md                                   |   5 +
 12-cluster.md                                      |   2 +
 15-modules.md                                      |   2 +
 config.yaml (gone)                                 | 117 ---------------------
 .../snippets/cluster/architecture-info.Rmd (new)   |   0
 .../cluster/authorized-keys-info.Rmd (new)         |   0
 .../cluster/secure-connections-info.Rmd (new)      |   0
 .../snippets/cluster/transfer-nodes-info.Rmd (new) |   0
 .../snippets/modules/default-modules.Rmd (new)     |   0
 .../scheduler/basic-job-status-output.Rmd (new)    |   4 +
 md5sum.txt                                         |  38 +++----
 12 files changed, 35 insertions(+), 136 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2026-02-05 09:30:40 +0000

github-actions Bot pushed a commit that referenced this pull request Feb 5, 2026
Comment thread episodes/10-hpc-intro.Rmd
separate window, then press `P` to toggle **p**resentation mode.


```{r, echo=FALSE, results='asis'}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's take advantage of the fact that this is R and insert comments here to explain the existence/purpose of this (and indeed all snippets!). It could also be somehow signified in the name of the Rmd that is intended for customization/localization purposes (like with a _localization in the filename, or a special subdirectory within snippets).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand the need for this but I am not a big fan of placing them in specific locations within the lesson. We will end up with similar items peppered everywhere. I would be more inclined to support placeholders at the beginning and end of each episode so that people have more freedom to tweak the scope.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did suggest a while ago that each lesson should have preamble and postamble snippets, but there was pushback on this as it could lead to local customisations taking priority over upstream contributions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants