lesson-example icon indicating copy to clipboard operation
lesson-example copied to clipboard

Links in footer menu pointing to repo blobs

Open vuw-ecs-kevin opened this issue 7 years ago • 3 comments

Subject: | [Discuss] Release candidate for next (v9.3.0) lesson template From: | "Raniere Silva" [email protected] Date: | Sun, November 5, 2017 23:20

Only just got a chance to look at this, but I notice that in the "footer menu"

Edit on GitHub / Contributing / Source / Cite / Contact

some of the links are still (?) pointing to blobs in the repo, and not files rendered from the lesson's sources?

The current lesson, as rendered at github.io, which I just viewed, has these link targets

Edit on GitHub: https://github.com/swcarpentry/lesson-example/edit/gh-pages/index.md Contributing: https://github.com/swcarpentry/lesson-example/blob/gh-pages/CONTRIBUTING.md Source: https://github.com/swcarpentry/lesson-example/ Cite: https://github.com/swcarpentry/lesson-example/blob/gh-pages/CITATION Contact: mailto:[email protected]

whereas, I had thought, following the related discussions in both the core

repos, that Contributing and Cite were now going to be handled by your replacement mechanism, for the older permalink markup approach, and would thus be rendered akin to most of the links in the main menubar, so say:

Code of Conduct: http://swcarpentry.github.io/lesson-example/CONDUCT.html

where the source file from the lesson CONDUCT.md gest automatically turmed into a "lesson-local" link, ie to CONDUCT.html ?

If I am recalling the discussions correctly, that would given these links

Contributing: [http://swcarpentry.github.io/lesson-example/CONTRIBUTING.html]

Cite: [http://swcarpentry.github.io/lesson-example/CITATION.html]

neither of which HTML file exists, hence me commnting them out above!

I note, from the current repo code filelist, that CONTRIBUTING.md is there, but that CITATION.md isn't, but that there is just the old plan text CITATION file that kind of sits there doing nothing at present?

Hoping that's a useful spot, and not just me missing some decision that "knocked back" those parts of the original "proposal".

All the best for the roll-out, Kevin

-- Kevin M. Buckley

eScience Consultant School of Engineering and Computer Science Victoria University of Wellington New Zealand

vuw-ecs-kevin avatar Nov 08 '17 04:11 vuw-ecs-kevin

@vuw-ecs-kevin Thanks for the issue. https://raw.githubusercontent.com/swcarpentry/lesson-example/gh-pages/CONTRIBUTING.md and https://raw.githubusercontent.com/swcarpentry/lesson-example/gh-pages/CITATION don't have the YAML header required by Jekyll so it converted to a HTML page. I changed the title of this issue to make it clear that we need to discuss it more.

rgaiacs avatar Nov 19 '17 21:11 rgaiacs

@fmichonneau Can you include this for discussion? Thanks.

rgaiacs avatar May 13 '18 10:05 rgaiacs

Commenting on this to re-up it as it's also being discussed on https://github.com/datacarpentry/cloud-genomics/issues/3. We are working on some broad lesson-template changes, so aren't necessarily making some of the smaller changes right now. When we do a next template update release though, this is a change that I think would be relatively straightforward to include.

tracykteal avatar Aug 30 '18 13:08 tracykteal