Merge pull request carpentries#1 from carpentries/znk-update

update varnish

.Rbuildignore

@@ -8,3 +8,6 @@
 ^package-lock\.json$
 ^scripts/$
 ^LICENSE\.md$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.github/workflows/compile-css.yaml

@@ -27,7 +27,7 @@ jobs:
       - name: Comple js
         run: bash squash-a-script.sh
       - name: Install sass
-        run: brew install sass/sass/sass
+        run: npm install -g sass
       - name: Compile sass
         run: bash squash-sass.sh
       - name: Commit

.github/workflows/pkgdown.yaml

@@ -0,0 +1,35 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Deploy package
+        run: |
+          git config --local user.name "$GITHUB_ACTOR"
+          git config --local user.email "[email protected]"
+          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'

.gitignore

@@ -1,2 +1,3 @@
 .Rproj.user
 node_modules/*
+docs

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: varnish
 Title: Front-end for The Carpentries Lesson Template
-Version: 0.1.4
+Version: 0.2.14
 Authors@R: c(
     person(given = "Zhian N.",
            family = "Kamvar",
@@ -18,4 +18,6 @@ License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.1
+RoxygenNote: 7.1.2
+URL: https://carpentries.github.io/varnish/
+BugReports: https://github.com/carpentries/varnish/issues/

NEWS.md

@@ -1,3 +1,179 @@
+# varnish 0.2.14
+
+* Workbench Beta Phase `Edit on GitHub` links no longer redirect people to the
+  beta phase intermediate page during the second stage of the beta phase.
+
+# varnish 0.2.13
+
+* Table display CSS is set to `table` as opposed to `block`, thus ensuring it is
+  represented correctly in the accessibility tree (see 
+  <https://developer.mozilla.org/en-US/docs/Web/CSS/display#tables>).
+  (fixed: @zkamvar, #74)
+* Table headings are now bold to easily distinguish from table contents.
+* Collapsing the sidebar no longer results in extra room at the bottom of the
+  page.
+
+# varnish 0.2.12
+
+* Table formatting has been fixed to no longer include 100px padding in the
+  first row (reported: @marklcrowe, #72; fixed: @zkamvar, 4385602)
+- All tables will now be striped for accessibility
+
+# varnish 0.2.11
+
+* Formatted print media to avoid breaking in important contexts (code blocks,
+  callout blocks, instructor notes) and shows solutions and instructor notes.
+  (reported: Anonymous, #70; fixed: @zkamvar, #71)
+
+# varnish 0.2.10
+
+* Fix issue with bullet points in callouts being mis-aligned 
+  (reported: @sstevens2, #68; fixed: @zkamvar, #69)
+
+# varnish 0.2.9
+
+- temporarily turn off matomo analytics
+
+# varnish 0.2.8
+
+- Workbench Beta phase "Edit on GitHub" links are now formatted correctly.
+  (reported: @zkamvar, #65; fixed @zkamvar, #66)
+
+# varnish 0.2.7
+
+* Lessons in different phases of the workbench beta phase will now have the URLs
+  redirect to a site that explains the purpose of the phase.
+
+# varnish 0.2.6
+
+* For lessons that use `workbench-beta: true`, the feedback URL has changed from
+  <https://github.com/carpentries/workbench/discussions/> to 
+  <https://carpentries.typeform.com/to/KRBl4IZM>, so that we can get more
+  specific feedback.
+
+# varnish 0.2.5
+
+* Workbench Beta messaging has been modified to be more visible and to link back
+  to the original lesson if possible.
+- The icon for lessons in "alpha" has been updated so it has a yellow background
+  with a grey glyph so that the icon shows up better.
+
+# varnish 0.2.4
+
+* Callout block titles have been improved: The underline height for titles have
+  been fixed to not look wonky when titles have multiple lines (reported:
+  @anenadic, #53; fixed @zkamvar, #55). Moreover, the text transformation will
+  no longer affect `code` and `kbd` elements. 
+* Heading element sizes have been recoded to use relative units. There was not 
+  enough specification in the original CSS to properly distinguish between H3
+  and H4 elements; moreover, on tablet and mobile devices, the H1 heading looked
+  smallter than the H2 heading due to a copy/paste error. This has been fixed by
+  using relative calcualtions (@zkamvar, #55)
+* Sidebar navigation now says "Episodes" instead of "Expand" when collapsed so 
+  that it is less confusing for folks. (suggested by @drmowinckels,
+  https://github.com/carpentries/workbench/issues/16 (#47); fixed by @zkamvar, 
+  #56)
+* The collapsed sidebar label no longer reverts to saying "collapse" on a new
+  page. 
+* The hamburger menu for mobile devices now has a border so it's more clear
+  that it is a menu (suggested by @drmowinckels,
+  https://github.com/carpentries/workbench/issues/16 (#47); fixed by @zkamvar, 
+  #57)
+
+
+# varnish 0.2.3
+
+* Add support for displaying anchor links (requested @fiveop, 
+  https://github.com/carpentries/sandpaper/issues/285 and @anenadic, 
+  https://github.com/carpentries/workbench/issues/28; added: #54 by @zkamvar)
+
+# varnish 0.2.2
+
+* Formatting of list elements in the solutions and instructor notes now follows
+  the same formatting as the rest of the content (reported: #51 by @tobyhodges, 
+  fixed: #52 by @zkamvar)
+
+# varnish 0.2.1
+
+* The sidebar navigation in mobile and tablet views now includes all the 
+  information that was included in the navigation bar for the desktop mode. 
+  (reported: https://github.com/carpentries/workbench/issues/16#issuecomment-1165307355 by @Athanasiamo and #49, fixed: #50 by @zkamvar)
+
+# varnish 0.2.0
+
+* The sidebar state (expanded or collapsed) will now persist during navigation
+  to another page in the same window/tab. Opening the site in a new window/tab
+  will reset the sidebar state to expanded. (reported: #43 by @anenadic, fixed
+  #46, @zkamvar). This fix uses the `sessionStorage` API. 
+
+# varnish 0.1.16
+
+* CHAPTERS has been temporarily renamed to EPISODES to reduce cognative load
+  between the webpage and the source folders
+
+# varnish 0.1.15
+
+* The search field has been disabled to avoid confusion. We have not yet enabled
+  search as this requires further testing. Disabling the search field means that
+  it is now more clear that search is not yet available.
+  (#44 by @zkamvar)
+
+# varnish 0.1.14
+
+* indicators for lesson development stage (pre-alpha, alpha, beta) have been 
+  added as `<abbr>` elements with a link to the appropriate section in the CDH
+  and `title` elements that describe the purpose of the stage. Visually hidden
+  text follows the `<abbr>` element for users who can not perceive the lesson
+  visually (#39 by @zkamvar, reviewed by @tobyhodges).
+* FIX: .lesson-title and .lesson-title-md are now inline-block elements
+
+# varnish 0.1.13
+
+* An alert for the workbench beta phase is implemented if the lesson has
+  `workbench-beta: true` in the `config.yaml`.
+
+# varnish 0.1.12
+
+* dropdown navigation no longer is hidden by the sidebar on XXL screens;
+  z-index of `nav.bottom-nav` set to 3.
+  (reported: #35 by @brownsarahm, fixed: #36 by @zkamvar)
+
+# varnish 0.1.11
+
+* blockquotes are now more clearly delineated from the rest of the content
+  (reported: #27 by @fiveop, fixed: #31 by @zkamvar)
+
+# varnish 0.1.10
+
+* lab and incubator logos are now available.
+
+# varnish 0.1.9
+
+* Fix missing pegboard version tag
+
+# varnish 0.1.8
+
+* custom workbench engines are now properly linked in the footer via the 
+  `sandpaper_cfg` `pegboard_cfg`, and `varnish_cfg` variables.
+* code of conduct link now points to the `CODE_OF_CONDUCT.md` file so authors
+  can update or modify their own code of conduct (NOTE: all Carpentries lessons
+  MUST have a code of conduct that links to the Carpentries Code of Conduct as
+  well as the reporting guidelines.
+
+# varnish 0.1.7
+
+* compile the changes from 0.1.6
+
+# varnish 0.1.6
+
+* Tables now scroll on overflow
+
+# varnish 0.1.5
+
+* The index page now has specific sections for schedule and setup that link to
+  the `#schedule` and `#setup` anchors. This partially addresses 
+  https://github.com/carpentries/sandpaper/issues/260
+
 # varnish 0.1.4
 
 * Removed " logo" suffix from the logo elements, as it is redundant

R/varnish-package.R

@@ -0,0 +1,10 @@
+#' The varnish package 
+#'
+#' This package does not contain any useful R code. It serves to hold CSS, JS,
+#' and HTML styling for Carpentries lessons. 
+#' @keywords internal
+"_PACKAGE"
+
+## usethis namespace: start
+## usethis namespace: end
+NULL