On Fri, September 29, 2017 12:23, Bree Norlander wrote: > I am working with a group of people interested in using github and > gh-pages to host curriculum for sharing/adapting/reusing. > They basically want a framework similar to what carpentries uses, > but are as of yet unfamiliar with git and github. I've offered to > give a workshop on github based on the carpentries curriculum, but > was wondering if anyone has taught gh-pages specifically?
Given that "gh-pages" is merely the typical name for the branch of a GitHub-hosted repository that is automatically rendered as the online view of a Carpentry lesson's content, the best place to start would obviously be the Software Carpentry's own lesson creation example: https://github.com/swcarpentry/lesson-example with the gh-pages branch of that rendered here http://swcarpentry.github.io/lesson-example/ as that contains, within just seven episodes 1 Lesson Design How do we design lessons? 2 GitHub, Markdown, and Jekyll How are pages published? 3 Lesson Organization How are the files in a lesson organized? 4 Formatting How are Software and Data Carpentry lessons formatted? 5 Checking and Previewing How can lesson formatting be checked? How can lessons be previewed? 6 Using RMarkdown How to write a lesson using RMarkdown? 7 Maintenance What do lesson maintainers do? a breakdown of everything needed to create Jekyll-based lesson content that can then be rendered as a web resource, along with links to the canonnical documentation for the various component technologies, eg Kramdown, which are at the core of a Carpentry lesson's source. Furthermore, because a lot of time and effort has obviously gone into the development of the framework used by the Carpentries, I'd suggest that your group are either going to find, once they have been led through the lesson-example, that most of what they want to do will either have been catered for or, where some small alterations are required, that the existing framework already gives them everything they need to achieve their ends. As an example of the latter, take a look at the vehicle I have been using to try and get some small modifications to the core style template out into the wider "carpentry consciousness", https://github.com/vuw-ecs-kevin/offline-capable-lesson (the default gh-pages branch of that GitHub repo being rendered here) https://vuw-ecs-kevin.github.io/offline-capable-lesson/ which, of itself, is also one simple exercise in using the existing capabilities of the well thought out Carpentry framework to achieve a slightly different result, whilst explcictly acknowledging the provenance of that end result. Hoping that's useful, Kevin --- Kevin M. Buckley eScience Consultant School of Engineering and Computer Science Victoria University of Wellington New Zealand _______________________________________________ Discuss mailing list [email protected] http://lists.software-carpentry.org/listinfo/discuss
