carpentries / workbench

Repository for Discussions and Materials about The Carpentries Workbench
https://carpentries.github.io/workbench/
Creative Commons Attribution 4.0 International
17 stars 7 forks source link

add a link to review and/or DOI in the banner for Lab lessons #67

Closed tobyhodges closed 8 months ago

tobyhodges commented 11 months ago

It would be nice to re-introduce the celebration of a lesson passing peer review that was displayed as a banner in styles:

Screenshot of the top of the Carpentries Lab lesson: Metagenomics Workshop Overview

In a Workbench lesson, I think this could be a message in the same space as the life cycle stage is currently displayed. I guess this means adding templating for this into sandpaper and maybe also defining styling in varnish, but I need a bit more time to explore before I can be certain.

@zkamvar if you and the other maintainers are happy with the suggestion feel free to assign this one to me.

zkamvar commented 11 months ago

Related: https://github.com/carpentries/varnish/issues/40

The best way to prototype this is to open up https://carpentries-incubator.github.io/good-enough-practices/, right click on the top of the lesson and open the inspector in your browser.

From there, you can play around with inserting text into the top bar.

This is what I've come up with using the bootstrap badging class:

header with all elements

doi badge

<abbr class="badge badge-light" title="This lesson has been peer-reviewed">
  <a href="https://cdh.carpentries.org/the-lesson-life-cycle.html#polishing-beta-stage" class="external-link alert-link" style="color: #383838;">
    <i aria-hidden="true" class="icon" data-feather="user-check" style="color: #FF4955; border-radius: 5px"></i>
    &nbsp; doi: XX.XXXXX
  </a>
  <span class="visually-hidden">This lesson has been peer reviewed</span>
</abbr>
tobyhodges commented 11 months ago

Ah, thanks for the breadcrumbs to old discussions that I had forgotten about altogether 😅 This is very helpful advice: I will begin working something up in the coming days.

zkamvar commented 11 months ago

To be fair, it took me a while to find the right issue