Skip to content

Commit

Permalink
Update index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@vgilbart
vgilbart authored Nov 13, 2024
1 parent 1eeba82 commit 1296fa3
Showing 1 changed file with 94 additions and 108 deletions.
202 changes: 94 additions & 108 deletions index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,21 @@ layout: workshop # DON'T CHANGE THIS.
# More detailed instructions (including how to fill these variables for an
# online workshop) are available at
# https://carpentries.github.io/workshop-template/customization/index.html
venue: "FIXME" # brief name of the institution that hosts the workshop without address (e.g., "Euphoric State University")
address: "FIXME" # full street address of workshop (e.g., "Room A, 123 Forth Street, Blimingen, Euphoria"), videoconferencing URL, or 'online'
country: "FIXME" # lowercase two-letter ISO country code such as "fr" (see https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) for the institution that hosts the workshop
language: "FIXME" # lowercase two-letter ISO language code such as "fr" (see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the workshop
latitude: "45" # decimal latitude of workshop venue (use https://www.latlong.net/)
longitude: "-1" # decimal longitude of the workshop venue (use https://www.latlong.net)
humandate: "FIXME" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020")
humantime: "FIXME" # human-readable times for the workshop e.g., "9:00 am - 4:30 pm CEST (7:00 am - 2:30 pm UTC)"
startdate: FIXME # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01
enddate: FIXME # machine-readable end date for the workshop in YYYY-MM-DD format like 2015-01-02
instructor: ["instructor one", "instructor two"] # boxed, comma-separated list of instructors' names as strings, like ["Kay McNulty", "Betty Jennings", "Betty Snyder"]
helper: ["helper one", "helper two"] # boxed, comma-separated list of helpers' names, like ["Marlyn Wescoff", "Fran Bilas", "Ruth Lichterman"]
email: ["[email protected]","[email protected]"] # boxed, comma-separated list of contact email addresses for the host, lead instructor, or whoever else is handling questions, like ["[email protected]", "[email protected]", "[email protected]"]
venue: "University of Strasbourg - ETENA" # brief name of the institution that hosts the workshop without address (e.g., "Euphoric State University")
address: "Coworking ETENA - Bâtiment hygiène 1, Pl. de l'Hôpital, 67000 Strasbourg" # full street address of workshop (e.g., "Room A, 123 Forth Street, Blimingen, Euphoria"), videoconferencing URL, or 'online'
country: "fr" # lowercase two-letter ISO country code such as "fr" (see https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) for the institution that hosts the workshop
language: "en" # lowercase two-letter ISO language code such as "fr" (see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the workshop
latitude: "48.57703038634505" # decimal latitude of workshop venue (use https://www.latlong.net/)
longitude: "7.7451497902970035" # decimal longitude of the workshop venue (use https://www.latlong.net)
humandate: "Jan 13, 2025" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020")
humantime: "9:00 am - 5:00 pm CET" # human-readable times for the workshop e.g., "9:00 am - 4:30 pm CEST (7:00 am - 2:30 pm UTC)"
startdate: 2025-01-13 # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01
enddate: 2025-01-13 # machine-readable end date for the workshop in YYYY-MM-DD format like
instructor: ["Valentine Gilbart", "Julien Godet"] # boxed, comma-separated list of instructors' names as strings, like ["Kay McNulty", "Betty Jennings", "Betty Snyder"]
helper: ["Valérie Cognat", "Stéfanie Graindorge"] # boxed, comma-separated list of helpers' names, like ["Marlyn Wescoff", "Fran Bilas", "Ruth Lichterman"]
email: ["[email protected]"] # boxed, comma-separated list of contact email addresses for the host, lead instructor, or whoever else is handling questions, like ["[email protected]", "[email protected]", "[email protected]"]
collaborative_notes: # optional: URL for the workshop collaborative notes, e.g. an Etherpad or Google Docs document (e.g., https://pad.carpentries.org/2015-01-01-euphoria)
eventbrite: # optional: alphanumeric key for Eventbrite registration, e.g., "1234567890AB" (if Eventbrite is being used)
what3words: # optional: what3words (https://what3words.com) address of the workshop venue, without leading slashes e.g. "globe.lessening.computers"
---

{% comment %} See instructions in the comments below for how to edit specific sections of this workshop template. {% endcomment %}
Expand All @@ -35,28 +34,6 @@ And run 'make workshop-check' *before* committing to make sure that changes are


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


<div class="alert alert-danger">
This is the workshop template. Delete these lines and use it to
<a href="https://carpentries.github.io/workshop-template/customization/index.html">customize</a>
your own website. If you are running a self-organized workshop or have not put
in a workshop request yet, please also fill in
<a href="{{site.amy_site}}/forms/self-organised/">this workshop request form</a>
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`
</div>

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

{% comment %}
Expand Down Expand Up @@ -119,12 +96,7 @@ href="{{site.swc_site}}">Software Carpentry</a>, <a href="{{site.dc_site}}">Data
<a href="{{site.lc_site}}">Library Carpentry</a> communities of Instructors, Trainers, Maintainers,
helpers, and supporters who share a mission to teach foundational computational and data science
skills to researchers.
<p align="center">
<em>
<strong>Want to learn more and stay engaged with The Carpentries?</strong> Carpentries Clippings is The Carpentries' biweekly newsletter, where we share community news, community job postings, and more.
Sign up to receive future editions and read our full archive: <a href="https://carpentries.org/newsletter/">https://carpentries.org/newsletter/</a>
</em>
</p>

{% if site.carpentry == "swc" %}
{% include swc/intro.html %}
{% elsif site.carpentry == "dc" %}
Expand All @@ -134,7 +106,8 @@ Sign up to receive future editions and read our full archive: <a href="https://c
{% 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.
<p>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.</p>

{% endif %}

{% comment %}
Expand Down Expand Up @@ -172,13 +145,11 @@ address.
<strong>Where:</strong>
{{page.address}}.
Get directions with
<a href="//www.openstreetmap.org/?mlat={{page.latitude}}&mlon={{page.longitude}}&zoom=16">OpenStreetMap</a>
or
<a href="//maps.google.com/maps?q={{page.latitude}},{{page.longitude}}">Google Maps</a>.
{% if page.what3words %}
What3Words location:
<a href="https://what3words.com/{{page.what3words}}">///{{page.what3words}}</a>.
{%endif %}

<a href="//maps.google.com/maps/place/Coworking+ETENA/@48.5769453,7.745123,16z/data=!3m1!4b1!4m6!3m5!1s0x4796c9ae7e6c2229:0xdf85dd5b8d436c0a!8m2!3d48.5769453!4d7.745123!16s%2Fg%2F11p9lwgt9c?entry=ttu&g_ep=EgoyMDI0MTExMC4wIKXMDSoASAFQAw%3D%3D">Google Maps</a>

or <a href="https://mob.u-strasbg.fr/geoloc/index.html?permalinkId=104"> University of Strasbourg permalink</a>. For those familiar with the Medecine Campus, Etena offices are in the building called "Administration faculté dentaire", close to "L'Amicale des étudiants de médecine de Strasbourg".

</p>
{% elsif online == "true_public" %}
<p id="where">
Expand Down Expand Up @@ -216,12 +187,12 @@ Modify the block below if there are any special 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.
Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.).
{% 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.
Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.).
{% endif %}
They should have a few specific software packages installed (listed <a href="#setup">below</a>).
They should have followed the Setup instructions prior to the day of the workshop (listed <a href="#setup">below</a>).
</p>

{% comment %}
Expand Down Expand Up @@ -359,8 +330,8 @@ SURVEYS - DO NOT EDIT SURVEY LINKS
<h2 id="surveys">Surveys</h2>
<p>Please be sure to complete these surveys before and after the workshop.</p>
{% if site.carpentry == "incubator" %}
<p><a href="{{ site.incubator_pre_survey }}">Pre-workshop Survey</a></p>
<p><a href="{{ site.incubator_post_survey }}">Post-workshop Survey</a></p>
<p><a href="{{ site.incubator_pre_survey }}">Pre-workshop Survey</a> (TBD)</p>
<p><a href="{{ site.incubator_post_survey }}">Post-workshop Survey</a> (TBD)</p>
{% elsif site.incubator_pre_survey or site.incubator_post_survey %}
<div class="alert alert-danger">
WARNING: you have defined custom pre- and/or post-survey links for
Expand Down Expand Up @@ -402,16 +373,37 @@ of code below the Schedule `<h2>` header below with

<h2 id="schedule">Schedule</h2>

{% 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
<a href="https://carpentries-incubator.org/">The Carpentries Incubator</a>. Please check <a href="{{site.incubator_lesson_site}}">the lesson homepage</a> for a list of lesson sections and estimated timings.
{% endif %}
<p>
<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.incubator_pre_survey }}" target="_blank">Pre-workshop survey</a></td>
</tr>
<tr> <!-- row 2 -->
<td>Morning</td> <!-- time -->
<td>Introducing R and RStudio, R Basics</td> <!-- content -->
</tr>
<tr>
<td>Lunch break</td> <!-- time -->
<td> - </td> <!-- content -->
</tr>
<tr>
<td>Afternoon</td> <!-- time -->
<td>Using packages, Data Wrangling and Visulization</td> <!-- content -->
</tr>
<tr>
<td>Before leaving</td> <!-- time -->
<td><a href="{{ site.incubator_post_survey }}" target="_blank">Post-workshop survey</a></td>
</tr>
</table>
</div>
</div>

</p>


{% comment %}
Edit/replace the text above if you want to include a schedule table.
Expand All @@ -420,7 +412,14 @@ 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 <a href="mailto:{{page.email}}">contact the workshop organisers</a> if you would like more information about the planned schedule.

<p>
Check <a href="{{site.incubator_lesson_site}}">the lesson homepage</a> for a list of lesson sections.
</p>

<p>The lesson taught in this workshop is being piloted and the described schedule can vary according to necessities. </p>

<p>The workshop will include breaks in the morning, for lunch and in the afternoon.</p>
{% endif %}

<hr/>
Expand All @@ -441,51 +440,38 @@ please preview your site before committing, and make sure to run
<h2 id="setup">Setup</h2>

<p>
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.
To participate, you will need access to R and RStudio and an up-to-date web browser.
Prior to the workshop, please either:
<ul>
<li>Install R and RStudio on your machine by following the instructions given in the Setup page of <a href="{{site.incubator_lesson_site}}">the lesson homepage</a> or <a href="https://posit.co/download/rstudio-desktop/">Posit download page</a></li>
<li>Use online RStudio by signing up to <a href="https://posit.cloud/">Posit Cloud</a> Free Plan </li>
</ul>
</p>

<p>
<i>NB: Posit is the new company name of the former RStudio company, follow the links to the wikipedia pages to learn more about the<a href="https://en.wikipedia.org/wiki/RStudio"> product RStudio</a>, and about <a href="https://en.wikipedia.org/wiki/Posit_PBC">the Posit PBC company</a>.</i>

</p>

<p>
We maintain a list of common issues that occur during installation as a reference for instructors
The Carpentries maintains 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 %}
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 instructions.
{% 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
<a href="{{site.incubator_lesson_site}}">the lesson homepage</a> for instructions to follow
to obtain the software and data you will need to follow the lesson.
{% endif %}
<p>
May you have any other issue in the installation, please contact at
{% if page.email %}
{% for email in page.email %}
{% if forloop.last and page.email.size > 1 %}
or
{% else %}
{% unless forloop.first %}
,
{% endunless %}
{% endif %}
<a href='mailto:{{email}}'>{{email}}</a>
{% endfor %}
{% else %}
{% endif %} or come in advance to the workshop so that we can help.
</p>

0 comments on commit 1296fa3

Please sign in to comment.