From d9dfa4de8d6d8261c93c5dee60a566794b36a3f2 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Fri, 7 Mar 2025 11:15:55 +0100 Subject: [PATCH 1/2] docs(preamble): :memo: add times to schedule and how long it is Closes #29 --- preamble/schedule.qmd | 32 ++++++++++++++++---------------- preamble/syllabus.qmd | 26 ++++++++++++++++++++------ 2 files changed, 36 insertions(+), 22 deletions(-) diff --git a/preamble/schedule.qmd b/preamble/schedule.qmd index 46ca098..ea298fe 100644 --- a/preamble/schedule.qmd +++ b/preamble/schedule.qmd @@ -1,19 +1,19 @@ # Schedule {#sec-schedule} -The tutorial is structured as a single participatory live-coding -session interspersed with a few hands-on exercises. The -*general* schedule outline is shown in the below table. -Instead, it is meant to be an approximate -guide and overview. +This 3-hour workshop is structured as a participatory live-coding +session interspersed with a few hands-on exercises, reading tasks, and +discussion activities. The *general* schedule is outlined in the below +table and is meant as an approximate guide *only*. The actual time spent +on each session may vary a bit. -| Session topic | -|:---| -| {{< fa mug-hot >}} Arrival, coffee and snacks | -| {{< fa person-chalkboard >}} [Introduction to the tutorial](/sessions/introduction.qmd) | -| {{< fa person-chalkboard >}} [The basics of GitHub and Git](/sessions/basics.qmd) | -| {{< fa mug-hot >}} Short break | -| {{< fa laptop-code >}} [Working with files on GitHub](/sessions/working-with-files.qmd) | -| {{< fa mug-hot >}} Short break | -| {{< fa laptop-code >}} [Making and using GitHub Issues](/sessions/using-issues.qmd) | -| {{< fa person-chalkboard >}} [Concluding remarks](/sessions/conclusion.qmd) | -| {{< fa comment-dots >}} [End of session short survey]() | +| Minutes | Session topic | +|:-----------------------------------|:-----------------------------------| +| | {{< fa mug-hot >}} Arrival, coffee and snacks | +| 10 | {{< fa person-chalkboard >}} [Introduction to the workshop](/sessions/introduction.qmd) | +| 40 | {{< fa person-chalkboard >}} [The basics of GitHub and Git](/sessions/basics.qmd) | +| 5 | {{< fa mug-hot >}} Short break | +| 50 | {{< fa laptop-code >}} [Working with files on GitHub](/sessions/working-with-files.qmd) | +| 5 | {{< fa mug-hot >}} Short break | +| 45 | {{< fa laptop-code >}} [Making and using GitHub Issues](/sessions/using-issues.qmd) | +| 5 | {{< fa person-chalkboard >}} [Concluding remarks](/sessions/conclusion.qmd) | +| 5 | {{< fa comment-dots >}} [End of session short survey]() | diff --git a/preamble/syllabus.qmd b/preamble/syllabus.qmd index ad05818..8477219 100644 --- a/preamble/syllabus.qmd +++ b/preamble/syllabus.qmd @@ -1,5 +1,17 @@ # Syllabus {#sec-syllabus} + + +This workshop takes 3 hours and is split into one short introduction +presentation, three main sessions, and a final concluding remarks +(including a short feedback survey): + +1. [Introduction to the workshop](/sessions/introduction.qmd) +2. [The basics of GitHub and Git](/sessions/basics.qmd) +3. [Working with files on GitHub](/sessions/working-with-files.qmd) +4. [Making and using GitHub Issues](/sessions/using-issues.qmd) +5. [Concluding remarks](/sessions/conclusion.qmd) + ## Learning outcome and objectives The aim of this workshop is to enable you to: @@ -17,7 +29,9 @@ will enable you to: Tangibly, during the workshop we will: - Create your own GitHub project (known as a *repository*) + - Create and edit text files on GitHub. + - Create Issues and comment on them. ## Is this for you? {#sec-is-it-for-you} @@ -33,13 +47,13 @@ in the workshop, such as one or more of the following: - You write text in documents as a main activity of your work. -- You are able to and are comfortable enough with only working on files - through a web browser interface (like GitHub's interface). +- You are able to and are comfortable enough with only working on + files through a web browser interface (like GitHub's interface). -While we have these assumptions to help focus the content of the workshop, -if you have an interest in the workshop but don't fit any of the -assumptions, *you are still welcome to attend*! We welcome -everyone, that is until capacity has been reached. +While we have these assumptions to help focus the content of the +workshop, if you have an interest in the workshop but don't fit any of +the assumptions, *you are still welcome to attend*! We welcome everyone, +that is until capacity has been reached. In addition to the assumptions, we also have a fairly focused scope for teaching and expectations for learning. So this may also help you decide From 896f509024bcd98aeafaac7ad70bdddb02b43521 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Fri, 7 Mar 2025 12:08:08 +0100 Subject: [PATCH 2/2] docs: :pencil2: suggestions from review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Signe Kirk Brødbæk <40836345+signekb@users.noreply.github.com> --- preamble/schedule.qmd | 6 +++--- preamble/syllabus.qmd | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/preamble/schedule.qmd b/preamble/schedule.qmd index ea298fe..4c9c028 100644 --- a/preamble/schedule.qmd +++ b/preamble/schedule.qmd @@ -9,11 +9,11 @@ on each session may vary a bit. | Minutes | Session topic | |:-----------------------------------|:-----------------------------------| | | {{< fa mug-hot >}} Arrival, coffee and snacks | -| 10 | {{< fa person-chalkboard >}} [Introduction to the workshop](/sessions/introduction.qmd) | -| 40 | {{< fa person-chalkboard >}} [The basics of GitHub and Git](/sessions/basics.qmd) | +| 15 | {{< fa person-chalkboard >}} [Introduction to the workshop](/sessions/introduction.qmd) | +| 45 | {{< fa person-chalkboard >}} [The basics of GitHub and Git](/sessions/basics.qmd) | | 5 | {{< fa mug-hot >}} Short break | | 50 | {{< fa laptop-code >}} [Working with files on GitHub](/sessions/working-with-files.qmd) | | 5 | {{< fa mug-hot >}} Short break | -| 45 | {{< fa laptop-code >}} [Making and using GitHub Issues](/sessions/using-issues.qmd) | +| 50 | {{< fa laptop-code >}} [Making and using GitHub Issues](/sessions/using-issues.qmd) | | 5 | {{< fa person-chalkboard >}} [Concluding remarks](/sessions/conclusion.qmd) | | 5 | {{< fa comment-dots >}} [End of session short survey]() | diff --git a/preamble/syllabus.qmd b/preamble/syllabus.qmd index 8477219..b7d1806 100644 --- a/preamble/syllabus.qmd +++ b/preamble/syllabus.qmd @@ -3,7 +3,7 @@ This workshop takes 3 hours and is split into one short introduction -presentation, three main sessions, and a final concluding remarks +presentation, three main sessions, and some final concluding remarks (including a short feedback survey): 1. [Introduction to the workshop](/sessions/introduction.qmd)