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

Port to Workbench format #221

Merged
merged 2 commits into from
Jun 27, 2024

Conversation

multimeric
Copy link
Contributor

@multimeric multimeric commented Jun 18, 2024

Closes #217.

You can find the rendered HTML here: https://wehi-researchcomputing.github.io/docker-introduction/.

Feedback is welcome.

@multimeric
Copy link
Contributor Author

Something I'm not sure about. The current material has objectives in the introduction page:

> ## After completing this session you should:
> - Have an understanding of what Docker containers are, why they are useful
> and the common terminology used
> - Have a working Docker installation on your local system to allow you to
> use containers
> - Understand how to use existing Docker containers for common tasks
> - Be able to build your own Docker containers by understanding both the role
> of a `Dockerfile` in building containers, and the syntax used in `Dockerfile`s
> - Understand how to manage Docker containers on your local system
> - Appreciate issues around reproducibility in software, understand how
> containers can address some of these issues and what the limits to
> reproducibility using containers are
{: .objectives}

No workbench lessons seem to do this, and indeed the workbench won't even display objectives in the intro. Not sure if I should delete these entirely?

@multimeric
Copy link
Contributor Author

I've also manually now checked all the output episodes, and I'm happy with everything. Nothing seems to have been missed.

@aturner-epcc
Copy link
Contributor

Something I'm not sure about. The current material has objectives in the introduction page:

> ## After completing this session you should:
> - Have an understanding of what Docker containers are, why they are useful
> and the common terminology used
> - Have a working Docker installation on your local system to allow you to
> use containers
> - Understand how to use existing Docker containers for common tasks
> - Be able to build your own Docker containers by understanding both the role
> of a `Dockerfile` in building containers, and the syntax used in `Dockerfile`s
> - Understand how to manage Docker containers on your local system
> - Appreciate issues around reproducibility in software, understand how
> containers can address some of these issues and what the limits to
> reproducibility using containers are
{: .objectives}

No workbench lessons seem to do this, and indeed the workbench won't even display objectives in the intro. Not sure if I should delete these entirely?

I think they can just be moved into the main text that appears at the top of the Summary and Setup page. It is important for learners to have an overview of what they will gain from the lesson so I would not want to lose them entirely.

@aturner-epcc
Copy link
Contributor

Thanks for all the work on this, I will have a look through and add any comments in my review.

@multimeric
Copy link
Contributor Author

I think they can just be moved into the main text that appears at the top of the Summary and Setup page. It is important for learners to have an overview of what they will gain from the lesson so I would not want to lose them entirely.

Currently I have it in a callout in this location: https://wehi-researchcomputing.github.io/docker-introduction/#after-completing-this-session-you-should. Let me know what you think.

@aturner-epcc
Copy link
Contributor

That looks perfect! I'll go through the rest of the PR over the next day or two.

Copy link
Contributor

@aturner-epcc aturner-epcc left a comment

Choose a reason for hiding this comment

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

Initial review of code and rendered material looks fine. I am going to merge this in and then we can deal with any teething issues via individual fixes.

@aturner-epcc aturner-epcc merged commit 9150957 into carpentries-incubator:gh-pages Jun 27, 2024
1 check passed
github-actions bot pushed a commit that referenced this pull request Jun 27, 2024
Auto-generated via {sandpaper}
Source  : 9150957
Branch  : gh-pages
Author  : Andy Turner <a.turner@epcc.ed.ac.uk>
Time    : 2024-06-27 14:12:18 +0000
Message : Merge pull request #221 from WEHI-ResearchComputing/main

Port to Workbench format
@multimeric
Copy link
Contributor Author

multimeric commented Jul 1, 2024

Thanks for the merge! If you could run a github pages build too, that would be great.

@aturner-epcc
Copy link
Contributor

I do not have permission to remove the gh-pages branch from the repo (it's existence is stopping the build from progressing as it pushes to this orphan branch). I have asked the repo admin (@sstevens2 ) to do this. If I don't not get a response soon, I will configure the build and publish to use another branch name.

@dme26
Copy link
Collaborator

dme26 commented Jul 1, 2024

Sorry there's a blocker for your work. Just double-checking that the default branch should become main, and if so I can effect changing the default and deleting gh-pages if sstevens2 isn't available.

@aturner-epcc
Copy link
Contributor

Thanks @dme26 . main is good for the default branch name

@dme26
Copy link
Collaborator

dme26 commented Jul 1, 2024

I've changed the default branch to main and have renamed gh-pages to previous-gh-pages. Just let me know if this doesn't unblock your progress. (Also, apologies @sstevens2 if I just invoked any particular forms of repository chaos in so doing.)

github-actions bot pushed a commit that referenced this pull request Jul 1, 2024
Auto-generated via {sandpaper}
Source  : 94ec900
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-06-27 14:25:25 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 9150957
Branch  : gh-pages
Author  : Andy Turner <a.turner@epcc.ed.ac.uk>
Time    : 2024-06-27 14:12:18 +0000
Message : Merge pull request #221 from WEHI-ResearchComputing/main

Port to Workbench format
@aturner-epcc
Copy link
Contributor

Thanks @dme26. @multimeric Deployed pages has now updated to workbench format so I think this is all working now.

github-actions bot pushed a commit that referenced this pull request Jul 2, 2024
Auto-generated via {sandpaper}
Source  : 94ec900
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-06-27 14:25:25 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 9150957
Branch  : gh-pages
Author  : Andy Turner <a.turner@epcc.ed.ac.uk>
Time    : 2024-06-27 14:12:18 +0000
Message : Merge pull request #221 from WEHI-ResearchComputing/main

Port to Workbench format
@sstevens2
Copy link
Contributor

Hi all! Thanks so much for all your work on this! Sorry I missed it in my notifications. So excited to see this moved to the workbench!

github-actions bot pushed a commit that referenced this pull request Jul 9, 2024
Auto-generated via {sandpaper}
Source  : 94ec900
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-06-27 14:25:25 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 9150957
Branch  : gh-pages
Author  : Andy Turner <a.turner@epcc.ed.ac.uk>
Time    : 2024-06-27 14:12:18 +0000
Message : Merge pull request #221 from WEHI-ResearchComputing/main

Port to Workbench format
github-actions bot pushed a commit that referenced this pull request Jul 16, 2024
Auto-generated via {sandpaper}
Source  : 94ec900
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-06-27 14:25:25 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 9150957
Branch  : gh-pages
Author  : Andy Turner <a.turner@epcc.ed.ac.uk>
Time    : 2024-06-27 14:12:18 +0000
Message : Merge pull request #221 from WEHI-ResearchComputing/main

Port to Workbench format
github-actions bot pushed a commit that referenced this pull request Jul 23, 2024
Auto-generated via {sandpaper}
Source  : 94ec900
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-06-27 14:25:25 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 9150957
Branch  : gh-pages
Author  : Andy Turner <a.turner@epcc.ed.ac.uk>
Time    : 2024-06-27 14:12:18 +0000
Message : Merge pull request #221 from WEHI-ResearchComputing/main

Port to Workbench format
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.

Convert to Workbench format
5 participants