Skip to content

review and updates for OER in Zenodo - #91

Merged
ariostas merged 44 commits into
hsf-training:gh-pagesfrom
oer-particle-physics:gh-pages
Sep 25, 2026
Merged

ariostas merged 44 commits into
hsf-training:gh-pagesfrom
oer-particle-physics:gh-pages

Conversation

@lauramarques

Copy link
Copy Markdown
Contributor

No description provided.

max-fatouros and others added 30 commits July 1, 2026 15:16
include recent updates from a merge request to the GitLab course
hsf-training/hsf-training-cicd#79
…d-hugo-modules

chore: refresh vendored Hugo modules
…d-hugo-modules

chore: refresh vendored Hugo modules
Also, add Gitea to title page.
@lauramarques

Copy link
Copy Markdown
Contributor Author

Hi @ariostas, can you please review the PR again? Many thanks.

@ariostas ariostas left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

For the second point below, I'll take care of it when I merge the PR.

🤖 AI text below 🤖

I left inline comments on the main issues. Two points don't map to a changed line:

  • .github/dependabot.yml: Dependabot still bumps GitHub Actions versions, but the new workflow files are synced from the hugo-styles template. A Dependabot PR that bumps an action in e.g. reusable-pages.yml will be overwritten by the template sync in pages.yml, so the "Verify synced files are committed" step would fail on every such PR. It may be worth excluding those files or dropping the github-actions ecosystem.
  • Deployment: the site is currently built by the legacy branch deploy (pages-build-deployment). Before merging, the repo's Pages source needs to be switched to "GitHub Actions". Otherwise the new deploy job fails and the legacy build runs Jekyll on the Hugo files. The README badge (line 9) also still points at pages-build-deployment.

Note: I couldn't build the site locally, so these come from reading the diff.

Comment thread content/episodes/12-skim-milk/index.md
Comment thread content/episodes/12-skim-milk/index.md
Comment thread content/episodes/08-adding-ci-to-your-code/index.md
Comment thread content/_index.md
Comment thread .pre-commit-config.yaml Outdated
Comment thread content/episodes/_index.md Outdated
@ariostas

ariostas commented Sep 21, 2026 •

Copy link
Copy Markdown
Member

Btw sorry for the conflicting information on the license part. It turned out that Zenodo doesn't accept multiple licenses, so we'll have to stick with only one.

🤖 AI text below 🤖

I also went through CITATION.cff and compared it with the GitLab lesson's file after hsf-training/hsf-training-cicd#83. It passes cffconvert --validate, and all ORCIDs are valid and match the listed names. A few things need fixing, though:

Authors

  • Giordon Stark created this lesson (136 commits to the episodes starting in 2019, and the only entry in the old AUTHORS) but is missing. He's listed first in the GitLab lesson (ORCID 0000-0001-6616-3433).
  • Kilian Lieret has about 23 commits to the episodes (prerequisites, questions, artifact and skim fixes). ORCID 0000-0003-2792-7511.
  • Guillermo A. Fidalgo-Rodríguez wrote the Docker material that became episode 17 (49e85c2). ORCID 0000-0001-8605-9772.
  • Florian Eble: the all-contributors table only credits a bug report, and he isn't in the GitLab lesson's list. Did he contribute content I missed?
  • Order: the GitLab lesson lists Giordon first, then everyone else alphabetically. It would be good to follow the same convention here.

DOI
10.5281/zenodo.22016969 is a version record that has been deleted from Zenodo (it returns 410). The concept DOI 10.5281/zenodo.22016968 resolves to this lesson and will point to the latest version after the next release. The README's Zenodo link uses the deleted DOI as well.

License
Zenodo's GitHub integration rejects a list for license ({'license': ['Not a valid string.']}), so the next release would fail to upload. Please use license: CC-BY-4.0, as in hsf-training/hsf-training-docker#107.

Abstract

  • "High Energy Physics Software Foundation" should be "HEP Software Foundation".
  • Lines 29 and 30 have trailing whitespace.
  • The title and abstract only mention GitHub, while the lesson is now titled "GitHub/Gitea Edition". It might be worth making them match.

AUTHORS
The GitLab lesson keeps AUTHORS in sync with CITATION.cff. Restoring it here with the same list would also bring back the authors section on the home page (see my earlier review comment on content/_index.md).

Suggested author block (keeping Florian for now):

authors:
  - given-names: Giordon
    family-names: Stark
    orcid: https://orcid.org/0000-0001-6616-3433
  - given-names: Saransh
    family-names: Chopra
    orcid: https://orcid.org/0000-0003-3046-7675
  - given-names: Aman
    family-names: Desai
    orcid: https://orcid.org/0000-0003-2631-9696
  - given-names: Florian
    family-names: Eble
    orcid: https://orcid.org/0009-0002-0638-3447
  - given-names: Max
    family-names: Fatouros
    orcid: https://orcid.org/0000-0002-7438-652X
  - given-names: Guillermo A.
    family-names: Fidalgo-Rodríguez
    orcid: https://orcid.org/0000-0001-8605-9772
  - given-names: Clemens
    family-names: Lange
    orcid: https://orcid.org/0000-0002-3632-3157
  - given-names: Kilian
    family-names: Lieret
    orcid: https://orcid.org/0000-0003-2792-7511
  - given-names: Laura
    family-names: Marqués
    orcid: https://orcid.org/0000-0002-3593-5557
  - given-names: Emery
    family-names: Nibigira
    orcid: https://orcid.org/0000-0001-5821-291X

@max-fatouros

Copy link
Copy Markdown
Contributor

Thanks @ariostas for the review, everything should now be addressed.

  • I kept Florian Eble for now. I'm also not sure if they contributed.
  • Instead of restoring the AUTHORS list, I've updated to hugo-styles v0.6.0, which pulls that data from CITATION.cff.
  • The workflows synced from hugo-styles are excluded from Dependabot.

@ariostas

ariostas commented Sep 22, 2026 •

Copy link
Copy Markdown
Member

Thank you, @max-fatouros. The hugo-styles change sounds great! And the rest also looks good to me. I there are just a couple of small things below.

I think the switch from the carpentries-style template to Hugo is good, especially since the old template is pretty outdated. In other places we've started to switch to Jupyter Book. This Hugo theme looks similar to Jupyter Book, so I'm fine with it, but I'll also see if other maintainers are fine with it.

🤖 AI text below 🤖

Thanks for the quick fixes, everything from the previous round looks good! Two more things:

The "install node" step
The install node step (wget of Node 20.18.1 into /usr/local) was added in 9342b63 and wasn't in the Jekyll version. It now shows up about 25 times in episodes 08–16, mostly in snippets shared by both platforms. GitHub runners supply Node to JavaScript actions in container: jobs on their own, which is why the lesson never needed this step before. Gitea runners need it when the ROOT images don't include Node. So GitHub learners currently see an extra step that is never explained, and its hardcoded Node version will go out of date.

The new GitHub tab in episode 12 already leaves the step out. Could the other episodes do the same, putting the step only in the Gitea tabs with a sentence explaining why Gitea needs it? One option is to explain it once in episode 08, where container: is introduced, and refer back to that in later episodes.

Florian Eble
I looked into this a bit more. Florian has no commits, issues or PRs in this repo. The only record is the all-contributors bot adding him for a bug report (#40, requested in #27), and he isn't an author of the GitLab lesson either. Let's remove him from the authors list in CITATION.cff. He will still be credited in the README's all-contributors table.

@max-fatouros

Copy link
Copy Markdown
Contributor

Thanks @ariostas, I've added Gitea tabs for the node installs, and removed Florian Eble.

And okay, let us know what the other maintainers think.

@ariostas ariostas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you @lauramarques and @max-fatouros!

@ariostas
ariostas merged commit 8d0021c into hsf-training:gh-pages Sep 25, 2026
4 checks passed
@welcome

welcome Bot commented Sep 25, 2026

Copy link
Copy Markdown

Congrats on merging your first pull request 🎉! We greatly appreciate it.
You might be eligible to be added to the HSF Training Community page (see the instructions on the page for how to create a profile). If you already have created a profile previously, make sure you're also added to the current year. If this repository features a list of contributors at the bottom of the readme, you might also be eligible to add yourself there.

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.

3 participants