Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a badge containing DOI for peer-reviewed lessons #97

Merged
merged 7 commits into from
Nov 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: varnish
Title: Front-end for The Carpentries Lesson Template
Version: 0.3.3
Version: 0.3.3.9000
Authors@R: c(
person(given = "Zhian N.",
family = "Kamvar",
Expand Down
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# varnish 0.3.3.9000

* life cycle icons are now displayed as badges for better visibility
* lessons that are stable with peer-reviewed doi releases will now have a doi
badge displayed with a link to the publication.

# varnish 0.3.3

* Code blocks in narrative no longer have a white background on top of the grey
Expand Down
2 changes: 1 addition & 1 deletion inst/pkgdown/assets/assets/styles.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion inst/pkgdown/assets/assets/styles.css.map

Large diffs are not rendered by default.

34 changes: 22 additions & 12 deletions inst/pkgdown/templates/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,42 @@
<img alt="{{#yaml}}{{carpentry_name}}{{/yaml}}" src="{{#site}}{{root}}{{/site}}assets/images/{{#yaml}}{{carpentry_icon}}-logo.svg{{/yaml}}">
{{#yaml}}{{#life_cycle}}
{{#pre_alpha}}
<abbr class="icon" title="This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught." style="text-decoration: unset">
&nbsp;
<a href="https://cdh.carpentries.org/the-lesson-life-cycle.html#early-development-pre-alpha-through-alpha" class="alert-link" style="color: #383838">Pre-Alpha
<i aria-hidden="true" class="icon" data-feather="alert-octagon" style="color: #FF4955; border-radius: 5px"></i>
<abbr class="badge badge-light" title="This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught." style="background-color: #FF4955; border-radius: 5px">
<a href="https://cdh.carpentries.org/the-lesson-life-cycle.html#early-development-pre-alpha-through-alpha" class="alert-link" style="color: #000">
<i aria-hidden="true" class="icon" data-feather="alert-octagon" style="border-radius: 5px"></i>
Pre-Alpha
</a>
<span class="visually-hidden">This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught.</span>
</abbr>
{{/pre_alpha}}
{{#alpha}}
<abbr class="icon" title="This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback." style="text-decoration: unset">
&nbsp;
<a href="https://cdh.carpentries.org/the-lesson-life-cycle.html#field-testing-alpha-stage" class="alert-link" style="color: #383838">Alpha
<i aria-hidden="true" class="icon" data-feather="alert-triangle" style="background: #FFC700; border-radius: 5px"></i>
<abbr class="badge badge-light" title="This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback." style="background-color: #FFC700; border-radius: 5px">
<a href="https://cdh.carpentries.org/the-lesson-life-cycle.html#field-testing-alpha-stage" class="alert-link" style="color: #383838">
<i aria-hidden="true" class="icon" data-feather="alert-triangle" style="border-radius: 5px"></i>
Alpha
</a>
<span class="visually-hidden">This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback.</span>
</abbr>
{{/alpha}}
{{#beta}}
<abbr class="icon" title="This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team." style="text-decoration: unset">
&nbsp;
<a href="https://cdh.carpentries.org/the-lesson-life-cycle.html#polishing-beta-stage" class="alert-link" style="color: #383838">Beta
<i aria-hidden="true" class="icon" data-feather="alert-circle" style="color: #001483; border-radius: 5px"></i>
<abbr class="badge badge-light" title="This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team." style="background-color: #001483; border-radius: 5px">
<a href="https://cdh.carpentries.org/the-lesson-life-cycle.html#polishing-beta-stage" class="alert-link" style="color: #FFF7F1">
<i aria-hidden="true" class="icon" data-feather="alert-circle" style="border-radius: 5px"></i>
Beta
</a>
<span class="visually-hidden">This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team.</span>
</abbr>
{{/beta}}
{{#stable}}
{{#doi}}
<abbr class="badge badge-light" title="This lesson has passed peer review" style="background-color: #FFE7A8; border-color: #0044d7; border-style: solid; border-radius: 5px">
<a href="https://doi.org/{{doi}}" class="external-link alert-link" style="color: #383838;">
<i aria-hidden="true" class="icon" data-feather="user-check" style="border-radius: 5px"></i>
DOI: {{doi}}
</a>
</abbr>
{{/doi}}
{{/stable}}
{{/life_cycle}}{{/yaml}}
</div>
</div>
Expand Down
9 changes: 5 additions & 4 deletions source/stylesheets/header.scss
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,8 @@
}

.large-logo img {
max-height: 64px
max-height: 64px;
margin-right: 1em
}

.navbar-toggler {
Expand Down Expand Up @@ -195,7 +196,7 @@
padding: inherit;
}

// the button x centered with the text,
// the button x centered with the text,
// not justified
.top-nav .beta-alert button.btn-close {
padding: 0.25rem 0.25rem 0.75rem 0.25rem;
Expand Down Expand Up @@ -268,7 +269,7 @@
z-index:3;
display: none;
filter: drop-shadow(0px 0px 5px white) drop-shadow(0px 0px 5px white) drop-shadow(0px 0px 5px white) drop-shadow(0px 0px 5px white) drop-shadow(0px 0px 5px white);

}

#to-top i {
Expand Down Expand Up @@ -321,7 +322,7 @@
.nav-container {
border: none;
}

.mobile-title {
display: none;
}
Expand Down
Loading