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 the introductory text on the Summary and Setup page to the first Episode #1062

Open
astroDimitrios opened this issue Jan 20, 2025 · 3 comments

Comments

@astroDimitrios
Copy link
Contributor

How could the content be improved?

Opening this here as it is a discussion we have been having on the Met Office version of the lesson.
Should we look at moving the paragraphs before the pre-req callout on the Summary and Setup page into Episode 1?
That way the pre-requisite callout would be higher on the page and we could put learning outcomes/objectives towards the top instead.
In the current form some of us feel that the text is overwhelming being so long and doesn't tell learners what the outcomes / pre-reqs are.

Which part of the content does your suggestion apply to?

https://swcarpentry.github.io/git-novice/

@martinosorb
Copy link
Contributor

martinosorb commented Jan 20, 2025

We could:

  • rename the first episode "Setup and prerequisites"
  • change the callout to a section
  • be a little more explicit about prerequisites, since at the moment it's not clear what exactly "expected but not mandatory" implies
  • move the introductory paragraph to Ep 1 as you say.

That would sound reasonable to me, so we isolate the technical stuff into the setup, and put the introductory and motivating stuff all together.
As it is, that paragraph is possibily often missed by instructors, who may have asked learners to setup before the worshop and therefore won't cover it again.

To play devil's advocate, it's possible that the paragraph was there specifically so that it is read by learners while setting up before the workshop, so we should perhaps discuss that.

@erinmgraham
Copy link
Contributor

I agree most of the introductory paragraph text would be better suited to Ep 1.

I took a look at the other SwC lessons and to be consistent with them my thoughts are:

  • leave the episode name as Summary and Setup
  • leave the Prereq callout as a callout
  • be more explicit about the Prereqs (other lessons mention eg, basics of file systems)
  • shorten the S&S introductory paragraphs to eg, just the last paragraph ['Version control is..."] with an extra sentence at the end , "For example, in this lesson we have imagined a scenario where two cooks hired by Ratatouille restaurant from Euphoric State University aim to create the best recipe archive while indexing prices simultaneously. However, they've faced issues with waiting for each other or losing, overwriting, or duplicating changes when working on separate copies." This goes well with the 'it isn't just for software'
  • move the remaining paragraphs to ep 1 (just not sure where; as much as I love that phd comic it kind of feels like a second scenario)

@martinosorb
Copy link
Contributor

Great. @astroDimitrios any thoughts on this, and would you be willing to submit a PR if you have ideas on how to implement it?

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

No branches or pull requests

3 participants