Skip to content

Commit b340728

Browse files
authored
docs: ✏️ "tutorial" -> "workshop" (#51)
## Description Since we agreed to move away from "tutorial" to avoid confusing it with diátaxis's more technical/non-interactive definition of tutorials Q: Should we rename the repo and url as well? For now, I kept it as is. Closes #44 <!-- Please delete as appropriate: --> This PR needs a quick review. ## Checklist - [X] Ran `just run-all`
1 parent 85cbe21 commit b340728

File tree

8 files changed

+34
-34
lines changed

8 files changed

+34
-34
lines changed

LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ Copyright (c) 2025 Luke W. Johnston and Signe Kirk Brødbæk
44

55
<a rel="license" href="https://creativecommons.org/licenses/by/4.0/"><img src="https://i.creativecommons.org/l/by/4.0/88x31.png" alt="Creative Commons License" style="border-width:0"/></a>
66

7-
The tutorial material is licensed under the [Creative Commons Attribution
7+
The workshop material is licensed under the [Creative Commons Attribution
88
4.0 International License](https://creativecommons.org/licenses/by/4.0/)
99
License.

README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,37 @@
22

33
## Description
44

5-
TODO: Very brief intro, motivation, and overview of tutorial.
5+
TODO: Very brief intro, motivation, and overview of workshop.
66

77
This repository contains the lesson, lecture, and assignment material
8-
for the tutorial, including the website source files and other associated
9-
tutorial administration files.
8+
for the workshop, including the website source files and other associated
9+
workshop administration files.
1010

11-
For more detail on the tutorial, check out the [welcome page]().
11+
For more detail on the workshop, check out the [welcome page]().
1212

1313
## Instructional Design
1414

15-
The lectures and lessons in this tutorial are designed to be presented
15+
The lectures and lessons in this workshop are designed to be presented
1616
primarily with a participatory live-coding approach. This involves an
1717
instructor typing and running code in
1818
[RStudio](https://posit.co/products/open-source/rstudio/) in front of
1919
the class, while the class follows along using their own computers.
2020
Challenges are interspersed in the lesson material, allowing
2121
participants to collaboratively work on smaller coding problems for a
2222
few minutes. All lesson materials are provided ahead of time on the
23-
tutorial website for participants to refer to during lectures.
23+
workshop website for participants to refer to during lectures.
2424

2525
## Lesson content
2626

2727
The teaching material is found mainly in these locations:
2828

29-
- `index.Rmd`: Contains the overview of the tutorial.
29+
- `index.Rmd`: Contains the overview of the workshop.
3030
- `preamble/` folder: Contains the files necessary for use before the
31-
tutorial, for instance the syllabus, schedule, and pre-tutorial tasks.
32-
- `sessions/` folder: Contains the files used during the tutorial (e.g.
31+
workshop, for instance the syllabus, schedule, and pre-workshop tasks.
32+
- `sessions/` folder: Contains the files used during the workshop (e.g.
3333
code-along material)
34-
- `appendix/` folder: Contains the files used to support the tutorial,
35-
such as pre-tutorial tasks, code of conduct, resources, and
34+
- `appendix/` folder: Contains the files used to support the workshop,
35+
such as pre-workshop tasks, code of conduct, resources, and
3636
instructions for instructors.
3737
- `slides/`: The lecture slides are rendered into HTML slides from
3838
Markdown.
@@ -42,7 +42,7 @@ follows the file and folder structure conventions from that package.
4242

4343
## Contributing
4444

45-
If you are interested in contributing to the tutorial material, please
45+
If you are interested in contributing to the workshop material, please
4646
refer to the [contributing guidelines](CONTRIBUTING.md). For guidelines
4747
on how to be a helper or instructor, check out the [For
4848
Instructors](https://r-cubed.rostools.org/for-instructors.html) page.
@@ -53,7 +53,7 @@ this project, you agree to abide by its terms.
5353

5454
## Re-use
5555

56-
The tutorial is largely designed to be taught in the order given, as each
56+
The workshop is largely designed to be taught in the order given, as each
5757
session builds off of the previous ones. The easiest way to use this
5858
material is to use it as-is, making use of the tips and instructions
5959
found throughout this page. The only thing you might want to make as
@@ -68,7 +68,7 @@ build your own website from the material is outside the scope of this
6868
document but you can find more information on Quarto's
6969
[Publishing](https://quarto.org/docs/publishing/) page.
7070

71-
To help with general admin tasks of running the tutorial, there is the
71+
To help with general admin tasks of running the workshop, there is the
7272
[r3admin](https://github.com/rostools/r3admin) R package. For details of
7373
the license and acknowledgement of content used from sources, see the
7474
[license](TODO) page of the website.

_quarto.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ project:
55
# - slides/*.html
66

77
book:
8-
title: "Introduction tutorial to GitHub"
8+
title: "Introduction to GitHub"
99
author:
1010
- Signe Kirk Brødbæk
1111
- Luke W. Johnston

appendix/for-instructors.qmd

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
A more general guide to instructing or helping is found on the
44
[Guides](https://guides.rostools.org/) website. This page has
5-
information relevant specifically to this tutorial.
5+
information relevant specifically to this workshop.
66

7-
## Pre-tutorial tasks
7+
## Pre-workshop tasks
88

9-
Before the tutorial, you should do the steps below.
9+
Before the workshop, you should do the steps below.
1010

1111
Optional, if it doesn't already exist:
1212

13-
- Make a GitHub organisation for the tutorial (if one doesn't already
13+
- Make a GitHub organisation for the workshop (if one doesn't already
1414
exist)
15-
- Make a repository for the tutorial (if one doesn't already exist)
15+
- Make a repository for the workshop (if one doesn't already exist)
1616

1717
Mandatory:
1818

preamble/syllabus.qmd

+6-6
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ will enable you to:
1414
{{< include /includes/_working-with-files-objectives.qmd >}}
1515
{{< include /includes/_using-issues-objectives.qmd >}}
1616

17-
Tangibly, during the tutorial we will:
17+
Tangibly, during the workshop we will:
1818

1919
- Create your own GitHub project (known as a *repository*)
2020
- Create and edit text files on GitHub.
2121
- Create Issues and comment on them.
2222

2323
## Is this for you? {#sec-is-it-for-you}
2424

25-
To help manage expectations and develop the material for this tutorial,
25+
To help manage expectations and develop the material for this workshop,
2626
we make a few possible assumptions about *who you are* as a participant
27-
in the tutorial, such as one or more of the following:
27+
in the workshop, such as one or more of the following:
2828

2929
- You want a gentle introduction to what GitHub is and how to use it.
3030

@@ -36,14 +36,14 @@ in the tutorial, such as one or more of the following:
3636
- You are able to and are comfortable enough with only working on files
3737
through a web browser interface (like GitHub's interface).
3838

39-
While we have these assumptions to help focus the content of the tutorial,
40-
if you have an interest in the tutorial but don't fit any of the
39+
While we have these assumptions to help focus the content of the workshop,
40+
if you have an interest in the workshop but don't fit any of the
4141
assumptions, *you are still welcome to attend*! We welcome
4242
everyone, that is until capacity has been reached.
4343

4444
In addition to the assumptions, we also have a fairly focused scope for
4545
teaching and expectations for learning. So this may also help you decide
46-
if this tutorial is for you.
46+
if this workshop is for you.
4747

4848
- We will only interact with GitHub from the website and from a web
4949
browser.

sessions/basics.qmd

+5-5
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@ Specific learning objectives are:
1212

1313
{{< include /includes/_basics-objectives.qmd >}}
1414

15-
## :speech_balloon: Discussion activity: Recall what you read during the pre-tutorial tasks
15+
## :speech_balloon: Discussion activity: Recall what you read during the pre-workshop tasks
1616

1717
**Time: \~5 Minutes**
1818

19-
Before we start the tutorial, we'll take some time to "prime" your
19+
Before we start the workshop, we'll take some time to "prime" your
2020
memory and activate your prior learning of what you read during the
21-
pre-tutorial tasks. Then after this activity, you'll again read the
22-
description of Git and GitHub from pre-tutorial tasks. We do this
21+
pre-workshop tasks. Then after this activity, you'll again read the
22+
description of Git and GitHub from pre-workshop tasks. We do this
2323
because effective learning is about retrieval, repetition, and actively
2424
engaging in the material. So:
2525

2626
1. For 1 minute, recall what you understood about Git and GitHub from
27-
the pre-tutorial tasks. Think about how you'd explain it to someone
27+
the pre-workshop tasks. Think about how you'd explain it to someone
2828
else.
2929
2. For 4 minutes, pair up with your neighbour and take turns explaining
3030
to them what you remember, 2 minutes each.

sessions/introduction.qmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Introduction to tutorial {#sec-introduction}
1+
# Introduction to workshop {#sec-introduction}
22

33
> [**Introduction slides**](../slides/introduction.html)
44

slides/introduction.qmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ format: r3-theme-revealjs
33
search: false
44
---
55

6-
# Welcome to the TODO: add tutorial name
6+
# Welcome to the TODO: add workshop name

0 commit comments

Comments
 (0)