rsg-theme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb980c9a87836cc8a5341a7059cca1f43fd0cec75b44632467883bc6e13e134c
+  data.tar.gz: 3657d0f20b58726a4e928458a2a7b7a2402b33951c0bae76a72305ded0197951
+SHA512:
+  metadata.gz: 246656be94b3544a29bb1c34f30f1684e61418f53412b800d267fbeb9ca135342b6f3bfc3637309be715e1bb9ab37e1920c3a5728b73ec2882c9896268576ebc
+  data.tar.gz: ca062926d605d6325fc044c437b7d5e5bfe5dea915022cdde6a465cb2d98647472d968015f349c5eab3c3032619b02bc71bcec1c62b525fc434adc7eaf168bff

data/_boilerplate/404.md

@@ -0,0 +1,25 @@
+---
+layout: base
+root: .
+permalink: 404.html
+title: "Page not found"
+---
+
+# Oops! We cannot find that page.
+{: style="text-align: center;"}
+
+> ## Our apologies!
+>
+> We cannot seem to find the page you are looking for.
+> Try going back to the <a href="javascript:history.back()">previous page</a> or
+> navigate to any other page using the navigation bar above
+> {%- if site.kind == "lesson" -%} or the schedule below {%- endif -%}.
+> If you got here by clicking on a link in the
+> {%- if site.kind == "lesson" -%} lesson {%- else -%} workshop {%- endif -%},
+> please report this link to the
+> {%- if site.kind == "lesson" -%} lesson developers {%- else -%} workshop organizers {%- endif -%}.
+{: .caution}
+
+{% if site.kind == "lesson" %}
+  {% include syllabus.html %}
+{% endif%}

data/_boilerplate/CODE_OF_CONDUCT.md

@@ -0,0 +1,12 @@
+---
+layout: page
+title: "Contributor Code of Conduct"
+---
+As contributors and maintainers of this project,
+we pledge to follow the [Carpentry Code of Conduct][coc].
+
+Instances of abusive, harassing, or otherwise unacceptable behavior
+may be reported by following our [reporting guidelines][coc-reporting].
+
+[coc]: https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html
+[coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html

data/_boilerplate/LICENSE.md

@@ -0,0 +1,83 @@
+---
+layout: page
+title: "Licenses"
+root: .
+---
+## Instructional Material
+
+This instructional material is
+made available under the [Creative Commons Attribution
+license][cc-by-human]. The following is a human-readable summary of
+(and not a substitute for) the [full legal text of the CC BY 4.0
+license][cc-by-legal].
+
+You are free:
+
+* to **Share** --- copy and redistribute the material in any medium or format
+* to **Adapt** --- remix, transform, and build upon the material
+
+for any purpose, even commercially.
+
+The licensor cannot revoke these freedoms as long as you follow the
+license terms.
+
+Under the following terms:
+
+* **Attribution**---You must give appropriate credit by:
+  - mentioning that your work is derived from work that is
+    Copyright © Software Carpentry, Data Carpentry, Library Carpentry,
+    or The Carpentries.
+  - where practical, linking to the respective lesson program website
+    (https://software-carpentry.org/, https://datacarpentry.org, https://librarycarpentry.org, or
+    https://carpentries.org), provide a [link to the license][cc-by-human]
+  - and indicate if changes were made. You may do so in any reasonable manner, but not in any way
+    that suggests the licensor endorses you or your use.
+
+**No additional restrictions** --- You may not apply legal terms or
+  technological measures that legally restrict others from doing anything the
+  license permits. With the understanding that:
+
+* You do not have to comply with the license for elements of the
+  material in the public domain or where your use is permitted by an
+  applicable exception or limitation.
+* No warranties are given. The license may not give you all of the
+  permissions necessary for your intended use. For example, other
+  rights such as publicity, privacy, or moral rights may limit how you
+  use the material.
+        
+## Software
+
+Except where otherwise noted, the example programs and other software
+provided in this lesson are made available under the
+[OSI][osi]-approved
+[MIT license][mit-license].
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+## Trademark
+
+"The Carpentries", "Software Carpentry" and "Data Carpentry" and their respective logos are
+registered trademarks of [Community Initiatives][CI].
+
+[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
+[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
+[mit-license]: https://opensource.org/licenses/mit-license.html
+[ci]: http://communityin.org/
+[osi]: https://opensource.org

data/_boilerplate/USAGE.md

@@ -0,0 +1,86 @@
+# carpentries-theme
+
+This repository provides a remote Jekyll theme for use with The Carpentries.
+
+> !!! CAUTION !!!
+>
+> This is *early alpha* work, not yet ready for wider adoption.
+
+Many lessons built for The Carpentries carry around the website theme assets
+such as CSS and favicons. These things evolve, but keeping a given lesson
+synchronized with the upstream [styles](https://github.com/carpentries/styles)
+repository, as well as the "best practice"
+[lesson-example](https://github.com/carpentries/lesson-example) repo,
+is laborious and error-prone. This project provides an alternative for those
+who do not need to customize the theme or do not wish to carry the code around
+as part of their repository.
+
+## Installation
+
+The goal is to help you carry around less code, not more. This is accomplished
+using [bundler](https://bundler.io/) and Jekyll remote themes. It is recommended
+that you carry out the process of trimming down on your local machine, in a
+separate branch, so you can easily get back if things don't go to plan:
+
+```bash
+$ git checkout -b install_carpentries-theme
+```
+
+The key step is to edit your `_config.yml` to point to this theme, adding
+
+```yml
+remote_theme: carpentries/carpentries-theme
+```
+
+to the end. With that done, please feel free to delete the `assets` folder:
+
+```bash
+$ git rm -r assets
+```
+
+You can also delete *almost* everything from `_includes`, again using `git rm`.
+If you have your own files in `_includes`, please use `git mv` to move them to
+`files` instead, and update links accordingly. Please retain the following
+files, if they exist; otherwise, the lesson will fail to build.
+
+- `all_figures.html`
+- `figure.html`
+
+Next, please synchronize the following items with the current versions in
+The Carpentries [styles](https://github.com/carpentries/styles) repository
+– retaining your local edits!
+
+- Folders
+  - `.github/`
+  - `bin/`
+
+- Files
+  - `CODE_OF_CONDUCT.md`
+  - `Gemfile`
+  - `LICENSE.md`
+  - `Makefile`
+  - `_config.yml`
+  - `.travis.yml`
+  - `aio.md`
+
+> *Note:* If you have not already configured Travis-CI to test your pull
+> requests and code before deploying, please do so by visiting
+> <https://travis-ci.org/github_user_name/repository_name>.
+
+Finally, build your local site using the remote theme.
+
+If you have GNU Make installed:
+
+```bash
+make serve
+```
+
+otherwise,
+
+```bash
+$ bundle install
+$ bundle exec jekyll serve
+```
+
+Check that everything looks correct, and that Jekyll throws no errors &ndash;
+then push your branch and file a pull request!

data/_boilerplate/aio.md

@@ -0,0 +1,13 @@
+---
+permalink: /aio/index.html
+---
+
+{% comment %}
+As a maintainer, you do not need to edit this file.
+If you notice that something does not work, please 
+open an issue: https://github.com/carpentries/styles/issues/new
+{% endcomment %}
+
+{% include base_path.html %}
+
+{% include aio-script.md %}

data/_boilerplate/index.md

@@ -0,0 +1,169 @@
+---
+layout: workshop      # DON'T CHANGE THIS.
+---
+
+<h2 id="general">General Information</h2>
+{% if site.venue == "TBC" %}
+<p>
+  <strong> Workshop location TBC </strong>
+</p>
+{% else if site.venue == "online" %}
+<p id="where">
+  Online at <a href="{{site.address}}">{{site.platform-name}}</a>.
+  If you need a password or other information to access the training,
+  the instructor will pass it on to you before the workshop.
+</p>
+{% else %}
+<p id="where">
+  <strong>Where:{{site.venue}}</strong>
+  <strong>Address:{{site.address}}</strong>
+</p>
+{% endif %}
+
+
+{% comment %}
+DATE
+
+This block displays the date.
+{% endcomment %}
+{% if site.humandate %}
+<p id="when">
+  <strong>When:</strong>
+  {{site.humandate}}.
+</p>
+{% endif %}
+
+{% comment %}
+SPECIAL REQUIREMENTS
+
+Modify the block below if there are any special requirements.
+{% endcomment %}
+<p id="requirements">
+  <strong>Requirements:</strong>
+  {% if online == "false" %}
+    Participants must bring a laptop with a
+    Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on.
+  {% else %}
+    Participants must have access to a computer with a
+    Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on.
+  {% endif %}
+  They should have a few specific software packages installed (listed <a href="#setup">below</a>).
+</p>
+
+{% comment %}
+ACCESSIBILITY
+
+Modify the block below if there are any barriers to accessibility or
+special instructions.
+{% endcomment %}
+<p id="accessibility">
+  <strong>Accessibility:</strong>
+{% if online == "false" %}
+  We are committed to making this workshop
+  accessible to everybody.  For workshops at a physical location, the workshop organizers have checked that:
+</p>
+<ul>
+  <li>The room is wheelchair / scooter accessible.</li>
+  <li>Accessible restrooms are available.</li>
+</ul>
+<p>
+  Materials will be provided in advance of the workshop and
+  large-print handouts are available if needed by notifying the
+  organizers in advance.  If we can help making learning easier for
+  you (e.g. sign-language interpreters, lactation facilities) please
+  get in touch (using contact details below) and we will
+  attempt to provide them.
+</p>
+{% else %}
+<p>
+  We are dedicated to providing a positive and accessible learning environment for all. Please
+  notify the instructors in advance of the workshop if you require any accommodations or if there is
+  anything we can do to make this workshop more accessible to you.
+</p>
+{% endif %}
+
+{% comment %}
+CONTACT EMAIL ADDRESS
+
+Display the contact email address set in the configuration file.
+{% endcomment %}
+<p id="contact">
+  <strong>Contact:</strong>
+  Please email
+  {% if site.email %}
+  {% for email in site.email %}
+  {% if forloop.last and site.email.size > 1 %}
+  or
+  {% else %}
+  {% unless forloop.first %}
+  ,
+  {% endunless %}
+  {% endif %}
+  <a href='mailto:{{email}}'>{{email}}</a>
+  {% endfor %}
+  {% else %}
+  to-be-announced
+  {% endif %}
+  for more information.
+</p>
+
+
+<hr/>
+
+
+{% comment %}
+SURVEYS - DO NOT EDIT SURVEY LINKS
+{% endcomment %}
+<h2 id="surveys">Surveys</h2>
+<p>Please be sure to complete these surveys before and after the workshop.</p>
+<p><a href="{{ site.pre_survey }}">Pre-workshop Survey</a></p>
+<p><a href="{{ site.post_survey }}">Post-workshop Survey</a></p>
+<hr/>
+
+
+{% comment %}
+SCHEDULE
+This schedule is either used from swc or it is autogenerated by the rsg/schedule
+and pulled from the lessons individually
+{% endcomment %}
+
+<h2 id="schedule">Schedule</h2>
+
+{% if site.carpentry == "swc" %}
+{% include swc/schedule.html %}
+{% elsif site.carpentry == "rsg" %}
+{% include rsg/schedule.html %}
+{% endif %}
+
+<hr/>
+
+<h2 id="setup">Setup</h2>
+
+<p>
+  To participate in
+  {% if site.carpentry == "swc" %}
+  a Software Carpentry
+  {% elsif site.carpentry == "rsg" %}
+  this training
+  {% endif %}
+  workshop,
+  you will need access to software as described below.
+  In addition, you will need an up-to-date web browser.
+</p>
+<p>
+  We maintain a list of common issues that occur during installation as a reference for instructors
+  that may be useful on the
+  <a href = "{{site.swc_github}}/workshop-template/wiki/Configuration-Problems-and-Solutions">Configuration Problems and Solutions wiki page</a>.
+</p>
+
+{% comment %}
+These are the installation instructions for the tools used
+during the workshop.
+If using RSG these are generated from each individual lesson
+{% endcomment %}
+
+{% if site.carpentry == "swc" %}
+{% include swc/setup.html %}
+{% elsif site.carpentry == "rsg" %}
+The instructions for all the software can be found <a href = "./setup"> on the setup page.</a>
+{% endif %}

data/_includes/aio-script.md

@@ -0,0 +1,25 @@
+{% comment %}
+As a maintainer, you don't need to edit this file.
+If you notice that something doesn't work, please
+open an issue: https://github.com/carpentries/styles/issues/new
+{% endcomment %}
+
+{% include manual_episode_order.html %}
+
+{% for lesson_episode in lesson_episodes %}
+
+{% if site.episode_order %}
+  {% assign e = site.episodes | where: "slug", lesson_episode | first %}
+{% else %}
+  {% assign e = lesson_episode %}
+{% endif %}
+
+<h1 id="{{ e.title | slugify }}" class="maintitle">{{ e.title }}</h1>
+
+{% include episode_overview.html teaching_time=e.teaching exercise_time=e.exercises episode_questions=e.questions episode_objectives=e.objectives %}
+
+{{ e.content }}
+
+{% include episode_keypoints.html episode_keypoints=e.keypoints %}
+<hr />
+{% endfor %}

data/_includes/all_keypoints.html

@@ -0,0 +1,31 @@
+{% comment %}
+  Display key points of all episodes for reference.
+{% endcomment %}
+
+{% include base_path.html %}
+{% include manual_episode_order.html %}
+
+<h2>Key Points</h2>
+<table class="table table-striped">
+{% for lesson_episode in lesson_episodes %}
+  {% if site.episode_order %}
+    {% assign episode = site.episodes | where: "slug", lesson_episode | first %}
+  {% else %}
+    {% assign episode = lesson_episode %}
+  {% endif %}
+  {% unless episode.break %}
+    <tr>
+      <td class="col-md-3">
+        <a href="{{ relative_root_path }}{{ episode.url }}">{{ episode.title }}</a>
+      </td>
+      <td class="col-md-9">
+        <ul>
+        {% for keypoint in episode.keypoints %}
+        <li>{{ keypoint|markdownify }}</li>
+        {% endfor %}
+        </ul>
+      </td>
+    </tr>
+  {% endunless %}
+{% endfor %}
+</table>

data/_includes/base_path.html

@@ -0,0 +1,41 @@
+{%- comment -%}
+When the website is built by GitHub Pages,
+'site.url' is set to 'https://username.github.io'
+'site.baseurl' is set to '/lesson-name'
+
+When we start a local server using `jekyll serve`,
+'site.url' is set to 'http://localhost:4000' and
+'site.baseurl' is empty.
+
+In both of the above cases we set 'relative_root_path' to 'site.baseurl'.
+
+When we build a website locally with `jekyll build`,
+both 'site.url' and 'site.baseurl' are empty.
+This case is handled by the last 'else' in the code below.
+The logic there follows the (adapted) instructions found at:
+    https://ricostacruz.com/til/relative-paths-in-jekyll
+
+    `page.url` gives the URL of the current page with a leading /:
+
+    - when the URL ends with an extension (e.g., /foo/bar.html),
+      we can get the 'depth' of the page by counting the number of
+      forward slashes ('/') and subtracting 1
+    - when the URL ends with a forward slash (e.g. /foo/bar/),
+      we can get the depth of the page by counting the number of /
+{%- endcomment -%}
+
+{% if site.url %}
+  {% assign relative_root_path = site.baseurl %}
+{% else %}
+  {% assign last_char = page.url | slice: -1 %}
+  {% if last_char == "/" %}
+    {% assign offset = 0 %}
+  {% else %}
+    {% assign offset = 1 %}
+  {% endif %}
+  {% assign depth = page.url | split: '/' | size | minus: offset %}
+  {% if    depth <= 1 %}{% assign relative_root_path = '.' %}
+  {% elsif depth == 2 %}{% assign relative_root_path = '..' %}
+  {% else %}{% capture relative_root_path %}..{% for i in (3..depth) %}/..{% endfor %}{% endcapture %}
+  {% endif %}
+{% endif %}

data/_includes/carpentries.html

@@ -0,0 +1,70 @@
+{% comment %}
+  General description of Software, Data, and Library Carpentry.
+{% endcomment %}
+
+{% include base_path.html %}
+
+<div class="row">
+  <div class="col-md-2" align="center">
+    <a href="{{ site.carpentries_site }}"><img src="{{ relative_root_path }}/assets/img/cp-logo-blue.svg" alt="The Carpentries logo" /></a>
+  </div>
+  <div class="col-md-8">
+    <p><a href="{{ site.carpentries_site }}">The Carpentries</a> comprises
+    Software Carpentry, Data Carpentry, and Library Carpentry communities of Instructors, Trainers,
+    Maintainers, helpers, and supporters who share a mission to teach
+    foundational coding and data science skills to researchers and people
+    working in library- and information-related roles. In January,
+    2018, The Carpentries was formed by the merger of Software Carpentry and
+    Data Carpentry. Library Carpentry became an official Carpentries Lesson Program in November 2018.</p>
+
+    <p>While individual lessons and workshops continue to be run under each
+    lesson project, The Carpentries provide overall staffing and governance, as
+    well as support for assessment, instructor training and mentoring.
+    Memberships are joint, and the Carpentries project maintains a shared Code
+    of Conduct. The Carpentries is a fiscally sponsored project of Community
+    Initiatives, a registered 501(c)3 non-profit based in California, USA.</p>
+  </div>
+</div>
+<div class="row">
+  <div class="col-md-2" align="center">
+    <a href="{{ site.swc_site }}"><img src="{{ relative_root_path }}/assets/img/swc-icon-blue.svg" alt="Software Carpentry logo" /></a>
+  </div>
+  <div class="col-md-8">
+     <p>Since 1998, <a href="{{ site.swc_site }}">Software Carpentry</a> has
+    been teaching researchers across all disciplines the foundational coding
+    skills they need to get more done in less time and with less pain. Its
+    volunteer instructors have run hundreds of events for thousands of learners
+    around the world. Now that all research involves some degree of
+    computational work, whether with big data, cloud computing, or simple task
+    automation, these skills are needed more than ever.</p>
+  </div>
+</div>
+<br/>
+<div class="row">
+  <div class="col-md-2" align="center">
+    <a href="{{ site.dc_site }}"><img src="{{ relative_root_path }}/assets/img/dc-icon-black.svg" alt="Data Carpentry logo" /></a>
+  </div>
+  <div class="col-md-8">
+    <p><a href="{{ site.dc_site }}">Data Carpentry</a> develops and teaches
+    workshops on the fundamental data skills needed to conduct research. Its
+    target audience is researchers who have little to no prior computational
+    experience, and its lessons are domain specific, building on learners'
+    existing knowledge to enable them to quickly apply skills learned to their
+    own research. Data Carpentry workshops take researchers through the entire
+    data life cycle.</p>
+  </div>
+</div>
+<br/>
+<div class="row">
+  <div class="col-md-2" align="center">
+    <a href="{{ site.lc_site }}"><img src="{{ relative_root_path }}/assets/img/lc-icon-black.png" alt="Library Carpentry logo" /></a>
+  </div>
+  <div class="col-md-8">
+    <p><a href="{{ site.lc_site }}">Library Carpentry</a> develops lessons and
+    teaches workshops for and with people working in library- and
+    information-related roles. Its goal is to create an on-ramp to empower this
+    community to use software and data in their own work, as well as be
+    advocates for and train others in efficient, effective and reproducible data
+    and software practices.</p>
+  </div>
+</div>

data/_includes/custom-schedule.html

@@ -0,0 +1,72 @@
+<div class="row">        <!-- first two days -->
+  <div class="col-md-6"> <!-- left column -->
+    <h3>Day 1</h3>
+    <table class="table table-striped">
+      <tr>               <!-- row 1   -->
+        <td>Before starting</td>
+        <td><a href="{{ site.pre_survey }}{{ site.github.project_title }}" target="_blank">Pre-workshop survey</a></td>
+      </tr>
+      <tr>               <!-- row 2   -->
+        <td></td>        <!-- time    -->
+        <td></td>        <!-- content -->
+      </tr>
+      <tr>               <!-- row 3   -->
+        <td></td>        <!-- time    -->
+        <td></td>        <!-- content -->
+      </tr>
+    </table>
+  </div>
+  <div class="col-md-6"> <!-- right column -->
+    <h3>Day 2</h3>
+    <table class="table table-striped">
+      <tr>               <!-- row 1   -->
+        <td></td>        <!-- time    -->
+        <td></td>        <!-- content -->
+      </tr>
+      <tr>               <!-- row 2   -->
+        <td></td>        <!-- time    -->
+        <td></td>        <!-- content -->
+      </tr>
+      <tr>               <!-- row 3   -->
+        <td></td>        <!-- time    -->
+        <td></td>        <!-- content -->
+      </tr>
+    </table>
+  </div>
+</div>
+<div class="row">        <!-- days 3 and 4 -->
+  <div class="col-md-6"> <!-- left column -->
+    <h3>Day 3</h3>
+    <table class="table table-striped">
+      <tr>               <!-- row 1   -->
+        <td></td>        <!-- time    -->
+        <td></td>        <!-- content -->
+      </tr>
+      <tr>               <!-- row 2   -->
+        <td></td>        <!-- time    -->
+        <td></td>        <!-- content -->
+      </tr>
+      <tr>               <!-- row 3   -->
+        <td></td>        <!-- time    -->
+        <td></td>        <!-- content -->
+      </tr>
+    </table>
+  </div>
+  <div class="col-md-6"> <!-- right column -->
+    <h3>Day 4</h3>
+    <table class="table table-striped">
+      <tr>               <!-- row 1   -->
+        <td></td>        <!-- time    -->
+        <td></td>        <!-- content -->
+      </tr>
+      <tr>               <!-- row 2   -->
+        <td></td>        <!-- time    -->
+        <td></td>        <!-- content -->
+      </tr>
+      <tr>               <!-- row 3   -->
+        <td>End</td>
+        <td><a href="{{ site.post_survey }}{{ site.github.project_title }}" target="_blank">Post-workshop survey</a></td>
+      </tr>
+    </table>
+  </div>
+</div>

data/_includes/episode_break.html

@@ -0,0 +1,15 @@
+{% comment %}
+    Display a break's timings in a box similar to a learning episode's.
+{% endcomment %}
+<blockquote class="objectives">
+  <h2>Overview</h2>
+
+  <div class="row">
+    <div class="col-md-3">
+      <strong>Break:</strong> {{ page.break }} min
+    </div>
+    <div class="col-md-9">
+    </div>
+  </div>
+
+</blockquote>

data/_includes/episode_keypoints.html

@@ -0,0 +1,18 @@
+{% comment %}
+  Display key points for an episode.
+{% endcomment %}
+
+{% if page.keypoints == nil %}
+{% assign episode_keypoints = include.episode_keypoints %}
+{% else %}
+{% assign episode_keypoints = page.keypoints %}
+{% endif %}
+
+<blockquote class="keypoints">
+  <h2>Key Points</h2>
+  <ul>
+    {% for keypoint in episode_keypoints %}
+    <li>{{ keypoint|markdownify }}</li>
+    {% endfor %}
+  </ul>
+</blockquote>