Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move workshop to GitHub Pages #266

Merged
merged 88 commits into from
Oct 24, 2024
Merged

Move workshop to GitHub Pages #266

merged 88 commits into from
Oct 24, 2024

Conversation

fasterius
Copy link
Collaborator

@fasterius fasterius commented Oct 18, 2024

Big PR here, with the overall changes required for moving to GitHub Pages using Roy's Specky template for Quarto. In summary:

  • The website is now a Quarto-based website hosted at GitHub Pages, built and deployed using GitHub Actions.
  • The website is accessed at https://nbisweden.github.io/workshop-reproducible-research/. It has important pages in a header (home, schedule, content, syllabus, pre-course and info), while lectures and pages can be found through links either in the schedule or content pages.
  • The tutorials/ and lectures/ directories and unchanged, except that HTML lectures are no longer directly stored in the main Git repository, but are accessed from the website itself.
  • The schedule can be changed by editing the schedule.xlsx Excel file in the repo root and will be formatted with cool code made by Roy.
  • The website environment has been consolidated with the lecture environments into a single Docker image hosted in GHCR for this repository, and is automatically built using GHA whenever it is changed. It is used when building and deploying the website, but can also be used for local testing.
  • The only thing left on Canvas will be the first page, which will be used as a landing page.

Some things still need to be done:

  • Go through lectures and check that they are formatted correctly for how they are rendered now.
  • Go through the entirety of the material and make sure that there is no odd formatting left from the conversion of the material from Markdown to Quarto. (Done, but needs other eyes as well.)
  • Check the other, already existing Actions and see which ones are not needed any more. (See comment below.)
  • Make new images where required (e.g. the front page), Roy is helping out. (Not needed for a merge but before the course starts.)
  • Resolve devel conflicts

My proposal for this new system would be that we only keep the main branch and either remove/archive or ignore the dev branch, which was only used for testing changes on Canvas. This is no longer necessary as new changes/contributions can be tested by building the website locally before opening a PR from a feature branch. We can keep tagging course rounds as we have done previously, which can be re-build locally if somebody wants to check out them, although experience leads me to believe that this is unlikely to be the case.

This PR is against the devel branch to get a better diff against the latest changes, but as soon as this PR is approved we should also merge it directly into main.

@johnne
Copy link
Collaborator

johnne commented Oct 22, 2024

Did we use this before as well for Windows or something, before we required WSL2 for Windows students?

Yes that's exactly what it was for

Remove the now unused GHA workflow for testing Conda environments in the
"slim" Docker image. This was a remnant of the pre-WSL2 era of Windows
when Docker was still used as a fail-safe installation. Since we now
require students to use the WSL2 this GHA is no longer necessary.
Do not run the Conda environment test on MacOS ARM64, as the `subread`
package is not available there.
@fasterius fasterius merged commit 85a2d06 into devel Oct 24, 2024
1 check passed
@fasterius fasterius deleted the specky branch October 24, 2024 07:01
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