Skip to content

Latest commit

 

History

History
469 lines (397 loc) · 17.5 KB

index.md

File metadata and controls

469 lines (397 loc) · 17.5 KB
layout venue address country language latitude longitude humandate humantime startdate enddate instructor helper email collaborative_notes eventbrite
workshop
FIXME
FIXME
FIXME
FIXME
45
-1
FIXME
FIXME
FIXME
FIXME
instructor one
instructor two
helper one
helper two

{% comment %} See instructions in the comments below for how to edit specific sections of this workshop template. {% endcomment %}

{% comment %} HEADER

Edit the values in the block above to be appropriate for your workshop. If the value is not 'true', 'false', 'null', or a number, please use double quotation marks around the value, unless specified otherwise. And run 'make workshop-check' before committing to make sure that changes are good. {% endcomment %}

{% comment %} 8< ============= For a workshop delete from here ============= For a workshop please delete the following block until the next dashed-line {% endcomment %}

This is the workshop template. Delete these lines and use it to customize your own website. If you are running a self-organized workshop or have not put in a workshop request yet, please also fill in this workshop request form to let us know about your workshop and our administrator may contact you if we need any extra information. If this is a pilot workshop for a new lesson, set the `pilot` field to `true` in `_config.yml`. For workshops teaching a lesson in The Carpentries Incubator, remember to uncomment the `incubator_lesson_site`, `incubator_pre_survey`, and `incubator_post_survey` fields in `_config.yml`

{% comment %} 8< ============================= until here ================== {% endcomment %}

{% comment %} Check DC curriculum {% endcomment %}

{% if site.carpentry == "dc" %} {% unless site.curriculum == "dc-astronomy" or site.curriculum == "dc-ecology" or site.curriculum == "dc-genomics" or site.curriculum == "dc-socsci" or site.curriculum == "dc-geospatial" %}

It looks like you are setting up a website for a Data Carpentry curriculum but you haven't specified the curriculum type in the _config.yml file (current value in _config.yml: "{{ site.curriculum }}", possible values: dc-astronomy, dc-ecology, dc-genomics, dc-socsci, or dc-geospatial). After editing this file, you need to run make serve again to see the changes reflected.
{% endunless %} {% endif %}

{% comment %} Check SWC curriculum {% endcomment %}

{% if site.carpentry == "swc" %} {% unless site.curriculum == "swc-inflammation" or site.curriculum == "swc-gapminder" %}

It looks like you are setting up a website for a Software Carpentry curriculum but you haven't specified the curriculum type in the _config.yml file (current value in _config.yml: "{{ site.curriculum }}", possible values: swc-inflammation, or swc-gapminder). After editing this file, you need to run make serve again to see the changes reflected.
{% endunless %} {% endif %}

{% comment %} EVENTBRITE

This block includes the Eventbrite registration widget if 'eventbrite' has been set in the header. You can delete it if you are not using Eventbrite, or leave it in, since it will not be displayed if the 'eventbrite' field in the header is not set. {% endcomment %} {% if page.eventbrite %} Some adblockers block the registration window. If you do not see the registration box below, please check your adblocker settings.

<iframe src="https://www.eventbrite.com/tickets-external?eid={{page.eventbrite}}&ref=etckt" frameborder="0" width="100%" height="280px" scrolling="auto"> </iframe> {% endif %}

General Information

{% comment %} INTRODUCTION

Edit the general explanatory paragraph below if you want to change the pitch. {% endcomment %} {% if site.carpentry == "swc" %} {% include swc/intro.html %} {% elsif site.carpentry == "dc" %} {% include dc/intro.html %} {% elsif site.carpentry == "lc" %} {% include lc/intro.html %} {% endif %}

{% if site.pilot %} This is a pilot workshop, testing out a lesson that is still under development. The lesson authors would appreciate any feedback you can give them about the lesson content and suggestions for how it could be further improved. {% endif %}

{% comment %} AUDIENCE

Explain who your audience is. (In particular, tell readers if the workshop is only open to people from a particular institution. {% endcomment %} {% if site.carpentry == "swc" %} {% include swc/who.html %} {% elsif site.carpentry == "dc" %} {% include dc/who.html %} {% elsif site.carpentry == "lc" %} {% include lc/who.html %} {% endif %}

{% comment %} LOCATION

This block displays the address and links to maps showing directions if the latitude and longitude of the workshop have been set. You can use https://www.latlong.net/ to find the lat/long of an address. {% endcomment %} {% assign begin_address = page.address | slice: 0, 4 | downcase %} {% if page.address == "online" %} {% assign online = "true_private" %} {% elsif begin_address contains "http" %} {% assign online = "true_public" %} {% else %} {% assign online = "false" %} {% endif %} {% if page.latitude and page.longitude and online == "false" %}

Where: {{page.address}}. Get directions with OpenStreetMap or Google Maps.

{% elsif online == "true_public" %}

Where: online at {{page.address}}. If you need a password or other information to access the training, the instructor will pass it on to you before the workshop.

{% elsif online == "true_private" %}

Where: This training will take place online. The instructors will provide you with the information you will need to connect to this meeting.

{% endif %}

{% comment %} DATE

This block displays the date and links to Google Calendar. {% endcomment %} {% if page.humandate %}

When: {{page.humandate}}. {% include workshop_calendar.html %}

{% endif %}

{% comment %} SPECIAL REQUIREMENTS

Modify the block below if there are any special requirements. {% endcomment %}

Requirements: {% 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 below).

{% comment %} ACCESSIBILITY

Modify the block below if there are any barriers to accessibility or special instructions. {% endcomment %}

Accessibility: {% 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:

  • The room is wheelchair / scooter accessible.
  • Accessible restrooms are available.

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.

{% else %} 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.

{% endif %}

{% comment %} CONTACT EMAIL ADDRESS

Display the contact email address set in the configuration file. {% endcomment %}

Contact: Please email {% if page.email %} {% for email in page.email %} {% if forloop.last and page.email.size > 1 %} or {% else %} {% unless forloop.first %} , {% endunless %} {% endif %} {{email}} {% endfor %} {% else %} to-be-announced {% endif %} for more information.

Roles: To learn more about the roles at the workshop (who will be doing what), refer to our Workshop FAQ.

{% comment %} WHO CAN ATTEND?

If you would like to specify who can attend the workshop, you can use the section below.

Move the 'endcomment' tag above the beginning of the following

tag to make this section visible.

Edit the text to match who can attend the workshop. For instance:

  • This workshop is open to affiliates to ABC university.
  • This workshop is open to the public.
  • If you are interested in attending this workshop, contact [email protected] for more information

Who can attend?: This workshop is open to ....

{% endcomment %}

{% comment%} CODE OF CONDUCT {% endcomment %}

Code of Conduct

Everyone who participates in Carpentries activities is required to conform to the Code of Conduct. This document also outlines how to report an incident if needed.

Report a Code of Conduct Incident


{% comment %} Collaborative Notes

If you want to use an Etherpad, go to

https://pad.carpentries.org/YYYY-MM-DD-site

where 'YYYY-MM-DD-site' is the identifier for your workshop, e.g., '2015-06-10-esu'.

Note we also have a CodiMD (the open-source version of HackMD) available at https://codimd.carpentries.org {% endcomment %} {% if page.collaborative_notes %}

Collaborative Notes

We will use this collaborative document for chatting, taking notes, and sharing URLs and bits of code.


{% endif %}

{% comment %} SURVEYS - DO NOT EDIT SURVEY LINKS {% endcomment %}

Surveys

Please be sure to complete these surveys before and after the workshop.

{% if site.carpentry == "incubator" %}

Pre-workshop Survey

Post-workshop Survey

{% elsif site.incubator_pre_survey or site.incubator_post_survey %}
WARNING: you have defined custom pre- and/or post-survey links for a workshop not configured for The Carpentries Incubator (the value of `curriculum` is not set to `incubator` in `_config.yml`). Please comment out the `incubator_pre_survey` and `incubator_post_survey` fields in `_config.yml` or, if this workshop is teaching a lesson in the Incubator, change the value of `carpentry` to `incubator`.
{% else %}

Pre-workshop Survey

Post-workshop Survey

{% endif %}

{% comment %} SCHEDULE

Show the workshop's schedule.

Small changes to the schedule can be made by modifying the schedule.html found in the _includes folder for your workshop type (swc, lc, or dc). Edit the items and times in the table to match your plans. You may also want to change 'Day 1' and 'Day 2' to be actual dates or days of the week.

For larger changes, a blank template for a 4-day workshop (useful for online teaching for instance) can be found in _includes/custom-schedule.html. Add the times, and what you will be teaching to this file. You may also want to add rows to the table if you wish to break down the schedule further. To use this custom schedule here, replace the block of code below the Schedule <h2> header below with {% include custom-schedule.html %}. {% endcomment %}

Schedule

{% if site.carpentry == "swc" %} {% include swc/schedule.html %} {% elsif site.carpentry == "dc" %} {% include dc/schedule.html %} {% elsif site.carpentry == "lc" %} {% include lc/schedule.html %} {% elsif site.carpentry == "incubator" %} This workshop is teaching a lesson in The Carpentries Incubator. Please check [the lesson homepage]({{ site.incubator_lesson_site }}) for a list of lesson sections and estimated timings. {% endif %}

{% comment %} Edit/replace the text above if you want to include a schedule table. See the contents of the _includes/custom-schedule.html file for an example of how one of these schedule tables is constructed. {% endcomment %}

{% if site.pilot %} The lesson taught in this workshop is being piloted and a precise schedule is yet to be established. The workshop will include regular breaks. Please contact the workshop organisers if you would like more information about the planned schedule. {% endif %}


{% comment %} SETUP

Delete irrelevant sections from the setup instructions. Each section is inside a 'div' without any classes to make the beginning and end easier to find.

This is the other place where people frequently make mistakes, so please preview your site before committing, and make sure to run 'tools/check' as well. {% endcomment %}

Setup

To participate in a {% if site.carpentry == "swc" %} Software Carpentry {% elsif site.carpentry == "dc" %} Data Carpentry {% elsif site.carpentry == "lc" %} Library Carpentry {% endif %} workshop, you will need access to software as described below. In addition, you will need an up-to-date web browser.

We maintain a list of common issues that occur during installation as a reference for instructors that may be useful on the Configuration Problems and Solutions wiki page.

{% comment %} For online workshops, the section below provides:

  • installation instructions for the Zoom client
  • recommendations for setting up Learners' workspace so they can follow along the instructions and the videoconferencing

If you do not use Zoom for your online workshop, edit the file _includes/install_instructions/videoconferencing.html to include the relevant installation instrucctions. {% endcomment %} {% if online != "false" %} {% include install_instructions/videoconferencing.html %} {% endif %}

{% comment %} These are the installation instructions for the tools used during the workshop. {% endcomment %}

{% if site.carpentry == "swc" %} {% include swc/setup.html %} {% elsif site.carpentry == "dc" %} {% include dc/setup.html %} {% elsif site.carpentry == "lc" %} {% include lc/setup.html %} {% elsif site.carpentry == "incubator" %} Please check the "Setup" page of [the lesson site]({{ site.incubator_lesson_site }}) for instructions to follow to obtain the software and data you will need to follow the lesson. {% endif %}