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

Add curriculum-specific schedule, setup, etc. #608

Merged
merged 28 commits into from
Oct 10, 2019

Conversation

fmichonneau
Copy link
Contributor

@fmichonneau fmichonneau commented Jun 21, 2019

Still to do:

  • include set up instructions for LC
  • test set up instructions for all variable combinations
  • revert to 'swc' as default in _config.yml
  • delete workshop-specific files from styles moved to remove workshop-specific files styles#421
  • update documentation

Please do not merge, this is work in progress.

  • Ready for review

@fmichonneau fmichonneau changed the title [WIP] Add curriculum Add curriculum-specific schedule, setup, etc. Jul 30, 2019
@fmichonneau
Copy link
Contributor Author

@ErinBecker (and lesson infrastructure committee) please review this. The goal is to provide more ready-to-use workshop templates for the various Data Carpentry curricula.

_config.yml Outdated
# cp: Carpentries (to use for instructor traning for instance)
# dc: Data Carpentry
# lc: Library Carpentry
# cp: Carpentries (to use for instructor traning for instance)
Copy link
Contributor

Choose a reason for hiding this comment

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

traning --> training

@ErinBecker
Copy link
Contributor

With (very) minor edits described above, this looks ready to merge to me. It is a significant improvement over the current setup for DC workshops. Thank you @fmichonneau for putting this together.

@maxim-belkin
Copy link
Contributor

I see that you did a lot of work here, François, so 👏

Something worries me, however. The new site.flavor variable is a high(er)-level selector of curriculum. While it is designed to solve problems, I wonder if it could cause some confusion.

I think that having workshop lessons listed in _config.yml as a lessons list, e.g.:

lessons:
 - swc-bash
 - swc-python-part1
 - swc-git
 - swc-python-part2

and instructing the workshop page to use this list to populate the schedule page would've allowed us to avoid these artificial higher-level curriculum selectors/constructs.

@brownsarahm
Copy link
Contributor

brownsarahm commented Sep 13, 2019

This appears to not allow choosing python or R for swc? and for swc python there are two lessons: gapminder and inflammation, how would that be indicated? I think something similar to Maxim's suggestion of allowing the instructor to specify the lessons could solve these

@fmichonneau
Copy link
Contributor Author

In its current form, these changes don't affect SWC workshops. Instructors would still have to edit the schedule and installation instructions manually. The main motivation behind this was to provide better support for DC workshops as the installation instructions and syllabi were completely missing for some curricula and we needed to provide more guidance and support to instructors for these workshops.

I'd be happy to extend this PR to make it easier to accommodate SWC workshops. A challenge I see (and I haven't given it a lot of thoughts at this time) is that DC workshops tend to follow the same schedule because there is a stronger narrative in the lessons, while SWC workshops tend to be more modular. This means SWC would always require some manual editing.

However, if we follow the same approach as what I started for DC, we could extend the curriculum variable to have the options swc-gapminder and swc-inflammation and the flavor variable could take the values r or python. Would you think that would be useful?

@ErinBecker
Copy link
Contributor

Thanks @maxim-belkin and @brownsarahm for raising concerns about how this PR doesn't address issues with SWC workshop website setup. I have tried to summarize this conversation in a new RFC for the Maintainers group (and @carpentries/lesson-infrastructure-committee) to discuss possible approaches. While that discussion is happening, I strongly recommend merging this PR in its current form, as the high error rate for DC workshop websites means that this issue is impacting a lot of learners at a lot of workshops. I'm all for extending a modular approach to SWC and LC workshop websites in the near future, but DC workshops are the ones with the highest user error rate and needs to be addressed soon.

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.

5 participants