search

carpentries-incubator / shell-extras

Extra Unix Shell Material
http://carpentries-incubator.github.io/shell-extras/
Other
26 stars 54 forks source link

Swap to jekyll 2 #37

Closed vuw-ecs-kevin closed 7 years ago

vuw-ecs-kevin commented 7 years ago

These commits take the swcarpentry:gh-pages branch, as it stood after

commit a975469c9053fa1ebf3e6a017199c04b7986597d
Merge: c7e0d30 83a83c8
Author: Greg Wilson <gvwilson@third-bit.com>
Date:   Thu May 12 10:37:12 2016 -0400

    Merge branch 'gh-pages' of github.com:swcarpentry/lesson-template into gh-pages

and modifies the underlying "lesson template" so that it matches the current lesson template for lessons that use the Jekyll build environment and which have content in their own repository and have manually added the styles repository as a remote.

The procedure for moving an old-style (not remote styles repository) lesson to the new stye, follows the ouline of the link mentioned in:

http://lists.software-carpentry.org/pipermail/discuss/2017-January/004982.html

although, as some of this work had already been investigated, it's a much smaller set of diffs than detailed in that link.

vuw-ecs-kevin commented 7 years ago

Anything likely to happen with this ? Or indeed, with the Shell Extras lessons in general ?

I note that a fair bit of the material covered in the Shell Extras lessons was used in a recent HPC "scaffolding" effort

https://software-carpentry.org/blog/2017/06/hpccarpentry.html

where it's clear that there's a need for people to be exposed to the basic UNIX tools and methodologies, BEFORE they start to think about any actual changes in approaches to coding for HPC resources.

The existing Shell Extras lessons, should they ever be given the chance to become part of the "Carpentry syllabus" by being formally given the current Look&Feel, clearly fill a need, but there's been little activity on here, although KristinaC does get a mention in that HPC "scaffolding" effort piece?

brandoncurtis commented 7 years ago

Didn't see this PR and accidentally duplicated this conversion work on another fork.

Is there any additional work needed to get this merged? I'd like to help fill in the blanks in this lesson for my new-instructor checkout.

vuw-ecs-kevin commented 7 years ago

I'll probably end up cross-posting between this PR and Brandon's here. or more likely duplicating this comment, but I wanted to point out that what got pulled in by this PR, actually goes a couple of stages further than the mere "Swap to jekyll 2", in that it also contains (should really have been on a seperate branch) some early thoughts I had had about simple changes to the underlying styles template that would allow for a correct navigation of the Lesson content, when viewing offline.

These changes don't affect the L&F of this lesson (one of the nice things about the extra approach), however, anyone cloning it may not be getting exactly what they think they are getting.

If there's a need to back those extras out, then I can look to do that.

FWIW, I decided to develop the "fully offline capable" idea in a standalone lesson that I have since created here:

https://github.com/vuw-ecs-kevin/offline-capable-lesson

with the rendered version visble here:

https://vuw-ecs-kevin.github.io/offline-capable-lesson/

ChristinaLK commented 7 years ago

I think it's fine for now -- it looks like Raniere is in the loop, so everything will end up where it needs to eventually.

rgaiacs commented 7 years ago

I think it's fine for now -- it looks like Raniere is in the loop, so everything will end up where it needs to eventually.

I would add @ChristinaLK as one of the reviews for https://github.com/swcarpentry/lesson-example/pull/127 but GitHub doesn't allow me. :-( Without her review I'm not sure if everything will end up where it needs to. ;-)