Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(preamble): 📝 add times to schedule and how long it is #74

Merged
merged 2 commits into from
Mar 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions preamble/schedule.qmd
Original file line number Diff line number Diff line change
@@ -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 |
| 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 |
| 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]() |
26 changes: 20 additions & 6 deletions preamble/syllabus.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Syllabus {#sec-syllabus}

<!-- TODO: Fill in this intro section. -->

This workshop takes 3 hours and is split into one short introduction
presentation, three main sessions, and some 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:
Expand All @@ -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}
Expand All @@ -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
Expand Down