datacarpentry / lesson-template-ARCHIVED

This is a repository that is a template for lessons
http://datacarpentry.github.io/lesson-template
Other
7 stars 14 forks source link

including install instructions in lesson template #11

Open tracykteal opened 9 years ago

tracykteal commented 9 years ago

I put in the install instructions, with each software as its own file to make it easier to mix and match for the workshop-template and also, I think it's nice to be able to include the install instructions on a given lesson, in case someone is using out of a workshop context.

It isn't optimal to include every setup instruction in every lesson repo though. Also, we're repeating information here and in the workshop-template repo. What would be a better way to handle this?

Or should we just not try to have installation instructions here?

gvwilson commented 9 years ago

One thing we're considering for SWC Version 6 is similar to what we use for keeping CSS and logos consistent:

  1. Create a repository whose gh-pages branch contains _includes/setup/whatever.html.
  2. All changes to setup instructions are made there.
  3. workshop-template and all the lesson repos have the setup instructions repo as a remote called 'setup'.
  4. We periodically 'git pull setup gh-pages' into workshop-template and the lesson repositories.
  5. We use %include in workshop-template and the lesson repositories to pull in the bits we need.

This way, there's one place for people to submit changes, which can then propagate everywhere under the control of the maintainers of the workshop template and individual lessons. It's a bit of a step backward