Skip to content

Refactoring the Snippet Library#4

Merged
ocaisa merged 7 commits intoocaisa:mainfrom
tkphd:snippet-library
Nov 7, 2025
Merged

Refactoring the Snippet Library#4
ocaisa merged 7 commits intoocaisa:mainfrom
tkphd:snippet-library

Conversation

@tkphd
Copy link
Copy Markdown

@tkphd tkphd commented May 15, 2025

This PR captures progress toward converting the Snippet Library and config files to work effectively with the Workbench.

Snippetized Workbenched version of the site -- currently for HPC Carpentry's MagicCastle cluster and a deliberately-corrupted Ghastly Mistakes variant to make testing easier.

Remaining issues (Documenting when to use a snippet) will be undertaken after migration to the Carpentries Incubator.

@tkphd tkphd marked this pull request as draft May 15, 2025 11:43
@github-actions
Copy link
Copy Markdown

github-actions bot commented May 15, 2025

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/ocaisa/probable-pancake/compare/md-outputs..md-outputs-PR-4

The following changes were observed in the rendered markdown documents:

 10-hpc-intro.md                                    |  56 +-
 11-connecting.md                                   |  44 +-
 12-cluster.md                                      |  20 +-
 13-scheduler.md                                    |  50 +-
 14-environment-variables.md                        |   6 +-
 15-modules.md                                      |  82 +-
 16-transferring-files.md                           |   4 +-
 17-parallel.md                                     |  67 +-
 18-resources.md                                    |  11 +-
 discuss.md (gone)                                  | 156 ----
 .../Ghastly_Mistakes/_config_options.yml (new)     |  66 ++
 .../Ghastly_Mistakes/cluster/queue-info.Rmd (new)  |   6 +
 .../cluster/specific-node-info.Rmd (new)           |  12 +
 .../modules/available-modules.Rmd (new)            |  24 +
 .../modules/missing-python.Rmd (new)               |  30 +
 .../modules/module-load-python.Rmd (new)           |   8 +
 .../modules/python-executable-dir.Rmd (new)        |  19 +
 .../modules/software-dependencies.Rmd (new)        |  79 ++
 .../parallel/eight-tasks.Rmd (new)                 |  58 ++
 .../Ghastly_Mistakes/parallel/four-tasks.Rmd (new) |  56 ++
 .../Ghastly_Mistakes/parallel/one-task.Rmd (new)   |  22 +
 .../resources/account-history.Rmd (new)            |  13 +
 .../scheduler/basic-job-script.Rmd (new)           |   3 +
 .../scheduler/basic-job-status.Rmd (new)           |   8 +
 .../scheduler/job-with-name-status.Rmd (new)       |   4 +
 .../scheduler/option-flags-list.Rmd (new)          |  15 +
 .../scheduler/print-sched-variables.Rmd (new)      |  32 +
 .../scheduler/runtime-exceeded-job.Rmd (new)       |   3 +
 .../scheduler/runtime-exceeded-output.Rmd (new)    |   5 +
 .../scheduler/terminate-job-begin.Rmd (new)        |   6 +
 .../scheduler/terminate-job-cancel.Rmd (new)       |   3 +
 .../scheduler/terminate-multiple-jobs.Rmd (new)    |  29 +
 .../scheduler/using-nodes-interactively.Rmd (new)  |  66 ++
 .../HPCC_MagicCastle_slurm/_config_options.yml     |   9 +-
 .../modules/available-modules.Rmd (new)            |  24 +
 .../modules/missing-python.Rmd (new)               |  30 +
 .../modules/module-load-python.Rmd (new)           |   8 +
 .../modules/python-executable-dir.Rmd (new)        |  19 +
 .../modules/software-dependencies.Rmd (new)        |  79 ++
 .../parallel/eight-tasks.Rmd (new)                 |  58 ++
 .../parallel/four-tasks.Rmd (new)                  |  56 ++
 .../parallel/one-task.Rmd (new)                    |  22 +
 .../resources/account-history.Rmd (new)            |  13 +
 learner-prerequisites.md (gone)                    |  83 --
 lesson_config.yaml                                 |  52 +-
 load_config.R                                      |  34 +-
 md5sum.txt                                         |  44 +-
 reference.md (gone)                                | 184 ----
 renv.lock (gone)                                   | 986 ---------------------
 49 files changed, 1097 insertions(+), 1667 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 2025-11-05 21:50:03 +0000

github-actions bot pushed a commit that referenced this pull request May 15, 2025
@ocaisa
Copy link
Copy Markdown
Owner

ocaisa commented May 15, 2025

Waiting for the nod from you to proceed with this @tkphd

@tkphd tkphd marked this pull request as ready for review October 2, 2025 12:11
github-actions bot pushed a commit that referenced this pull request Nov 5, 2025
@tkphd tkphd changed the title WIP: Refactoring the Snippet Library Refactoring the Snippet Library Nov 6, 2025
@tkphd tkphd requested a review from ocaisa November 6, 2025 12:48
Copy link
Copy Markdown
Owner

@ocaisa ocaisa left a comment

Choose a reason for hiding this comment

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

Just clicking throught that took ages, let's see it rendered!

@ocaisa ocaisa merged commit 264df4d into ocaisa:main Nov 7, 2025
3 checks passed
github-actions bot pushed a commit that referenced this pull request Nov 7, 2025
Auto-generated via `{sandpaper}`
Source  : 264df4d
Branch  : main
Author  : ocaisa <alan.ocais@cecam.org>
Time    : 2025-11-07 14:06:58 +0000
Message : Merge pull request #4 from tkphd/snippet-library

Refactoring the Snippet Library
github-actions bot pushed a commit that referenced this pull request Nov 7, 2025
Auto-generated via `{sandpaper}`
Source  : bafa407
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-11-07 14:11:59 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 264df4d
Branch  : main
Author  : ocaisa <alan.ocais@cecam.org>
Time    : 2025-11-07 14:06:58 +0000
Message : Merge pull request #4 from tkphd/snippet-library

Refactoring the Snippet Library
@tkphd tkphd deleted the snippet-library branch November 7, 2025 14:29
@tkphd
Copy link
Copy Markdown
Author

tkphd commented Nov 7, 2025

Thank you for the review!!!

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