1 Creating a new workshop
2 =======================
4 There is a central repository for boot camp material:
6 https://github.com/swcarpentry/workshop
8 The “master” branch has the current state-of-the-art source for the
9 instructors' projected content, handouts, workshop homepage, etc.
10 Different "editions" of material can live side-by-side in subdirectories.
12 Topics will live in per-subject subdirectories, ideally organized in
13 half-day-sized chunks.
37 Figure 1: Example directory tree for the current 2012-12-my-workshop
38 tip. Sections should be in half-day-ish chunks. Complicated topics
39 that need more detailed coverage (e.g. version control) can have
42 An instructor preparing for a new workshop should create a
43 new, empty repository on the SWC GitHub organization. Material can be
44 added to this repositry either by merging from the central repo or simply
45 copying in any material.
47 Developing workshop content
48 ===========================
50 If you don't have strong ideas about the content, there's probably not
51 much to do here besides tweaking a few workshop-specific bits
52 (location, dates, master-index, …). These changes should go into the
55 If you plan to make significant (but not workshop specific)
56 changes to workshop material you should
57 make those changes in your personal fork of the central repository. That way
58 it's easy to ask for those changes to be included in the central repo via
61 Publishing workshop websites
62 ============================
64 This is not really part of the workshop-branch vs. workshop-repo
65 discussion, but one benefit to the workshop-repo approach is that each
66 workshop may have a gh-pages website at
68 http://<user>.github.com/<repo>
69 http://swcarpentry.github.com/2012-12-my-workshop
71 Post-workshop archival
72 ======================
74 The workshop repositories are already on the SWC GitHub page, so
75 there's nothing to do here.