search

carpentries-incubator / docker-introduction

Reproducible Computational Environments using Containers
https://carpentries-incubator.github.io/docker-introduction/
Other
42 stars 48 forks source link

Port to Workbench format #221

Closed multimeric closed 5 days ago

multimeric commented 2 weeks ago

Closes #217.

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

Feedback is welcome.

multimeric commented 1 week ago

Something I'm not sure about. The current material has objectives in the introduction page: https://github.com/carpentries-incubator/docker-introduction/blob/15b3b4ff4f31b542d6b522262f3561ce69cb0801/index.md#L8-L20

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 commented 1 week ago

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

aturner-epcc commented 1 week ago

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

https://github.com/carpentries-incubator/docker-introduction/blob/15b3b4ff4f31b542d6b522262f3561ce69cb0801/index.md#L8-L20

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 commented 1 week ago

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

multimeric commented 1 week ago

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 commented 1 week ago

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

multimeric commented 2 days ago

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

aturner-epcc commented 2 days ago

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 commented 1 day ago

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 commented 1 day ago

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

dme26 commented 1 day ago

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.)

aturner-epcc commented 1 day ago

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