carpentries / carpentries/lesson-example

Links in footer menu pointing to repo blobs

Open
#142 3 comments 0 reactions 1 assignee Claimed by @fmichonneau View on GitHub
type:discussion
Dominant language
HTML
Stars
65
Forks
167
PR merge metrics
No merged PRs in 30d

Description

> Subject: | [Discuss] Release candidate for next (v9.3.0) lesson template
> From: | "Raniere Silva"
> 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:lessons@software-carpentry.org

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

- [swcarpentry/lesson-example](https://github.com/swcarpentry/lesson-example/pull/127)
- [swcarpentry/styles](https://github.com/swcarpentry/styles/pull/166)

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.