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

Webpage for CodeRefinery workshop, 27-29 August 2024, Gothenburg #1

Merged
merged 5 commits into from
Jun 24, 2024
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
16 changes: 8 additions & 8 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

# this variable has to be set but it is not used
# inside the templates (end in '/')
base_url = "https://coderefinery.github.io/template-workshop-webpage/"
base_url = "https://coderefinery.github.io/2024-08-27-gothenburg/"

# When adapting the title, do not forget to also adjust base_url above
title = "Replace this title in config.toml"
title = "CodeRefinery workshop in Gothenburg, August 27-29, 2024"
description = "Free workshop on git, testing, documentation, and more in a workshop - for researchers and scientists."

# Whether to automatically compile all Sass files in the sass directory
Expand All @@ -30,11 +30,11 @@ navigation = [
{ name = "List of exercises", target = "exercises/" },
{ name = "Audience", target = "audience/" },
{ name = "Certificates", target = "certificates/" },
{ name = "How to join", target = "join/" },
# { name = "How to join", target = "join/" },
{ name = "Requirements", target = "requirements/" },
{ name = "Q&A", target = "questions/" },
# { name = "Q&A", target = "questions/" },
{ name = "Code of conduct", target = "code-of-conduct/" },
{ name = "Communication", target = "communication/" }
# { name = "Communication", target = "communication/" }
]

twitter_image = "https://raw.githubusercontent.com/coderefinery/coderefinery-artwork/main/socialshare/socialshare-workshop.png"
Expand All @@ -51,9 +51,9 @@ logos = [
]

# adapt this
registration_link = "https://example.org"
source_repo = "https://github.com/coderefinery/template-workshop-webpage"
how_to_join_video = "https://youtu.be/QUAZELOioUY"
registration_link = "https://forms.office.com/e/ZpNzj9xStM"
source_repo = "https://github.com/coderefinery/2024-08-27-gothenburg"
#how_to_join_video = "https://youtu.be/QUAZELOioUY"

# uncomment as soon as registration opens
# registration_is_open = true
Expand Down
60 changes: 14 additions & 46 deletions content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,60 +2,28 @@
title = "Schedule"
+++

## Be a team leader
## Location

Do you know some of the topics, but want to review them?
Do you wish your colleagues or friends would use these tools?
Why not [attend as a team leader](@/join.md)?
Gather some friends who want to learn the topics and follow the workshop together.
You don't need to be an expert: if you have been through CodeRefinery once or have some familiarity
with the topics, and you are confident to call an expert helper when needed,
then you have all it takes to lead a team to success,
or lead even more people and join as an organization (see below).
Chalmers, Campus Johanneberg, Gothenburg, Sweden

## Partners

## Partners and local exercise groups
The workshop is offered in collaboration with C3SE, UPPMAX, PDC, and ENCCS.

Some partners offer local support, such as breakout rooms, to their local
teams. You can [become a partner](https://coderefinery.org/about/partners/) to
support your community!

We collect here the exercise groups that we know:
- [**Aalto University**](https://scicomp.aalto.fi/):
- Local in-person exercise session and local support.
- Possibility of [credit points](@/certificates.md) to those in Finland.
## Contact

If you have any questions regarding this workshop, please email [email protected] .

## Instructors

- ...

- Björn Claremar
- Yonglei Wang
- Johan Hellsvik
- Viktor Rehnberg

## Workshop organizers

- ...


## On-boarding

- ...


## Outreach

- ...


## Recording and broadcasting

- ...


## Local organizers

- ...


## Collaborative notes editors

- ...
- Björn Claremar
- Yonglei Wang
- Johan Hellsvik
- Viktor Rehnberg
6 changes: 3 additions & 3 deletions content/certificates.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ provide us with the following **three text documents sent from your university e

1. A document that shows that you did the exercises during the course. *Note: if you are planning to delete the exercise repository from your GitHub projects, instead of sending links to your work you can send PDF screenshots e.g. by doing "print to PDF" with your browser.*
- Write one or more paragraphs about [Day 1 - Exercise 2](https://coderefinery.github.io/git-intro/commits/#exercise): provide the link to the forked repository on your GitHub account and show that you did new commits. If you did not use GitHub and if you used the command line, then provide the output of the command `git log --all` for the forked repository. Explain what you did.
- Write one or more paragraphs about [Day 2 - Exercise 3](https://coderefinery.github.io/git-intro/sharing/#exercise): provide the link to the new repository you have created on your GitHub account. If you did not use GitHub and if you used the command line, then provide the output of the command `git log --all` for the newly created repository. Explain what you did.
- Write one or more paragraphs about [Day 3 - Exercise 1](https://coderefinery.github.io/git-collaborative/same-repository/#exercise): provide the link to the pull request. Explain what you did.
- Write one or more paragraphs about [Day 1 - Exercise 3](https://coderefinery.github.io/git-intro/sharing/#exercise): provide the link to the new repository you have created on your GitHub account. If you did not use GitHub and if you used the command line, then provide the output of the command `git log --all` for the newly created repository. Explain what you did.
- Write one or more paragraphs about [Day 2 - Exercise 1](https://coderefinery.github.io/git-collaborative/same-repository/#exercise): provide the link to the pull request. Explain what you did.
2. Written answers to the following four questions submitted as a document (pdf
or word or txt). Evaluation criteria: we expect critical answers related to
the content of first 3 days with both pros and cons (when relevant):
- When should you work with branches?
- What is the difference between a `git clone` and a `git fork`?
- What is the difference between a fork and a branch?
- What advantages and disadvantages to code review can you imagine/list?
3. A personal reflection for each of the 6 days written as a document (pdf or
3. A personal reflection for each of the 3 days written as a document (pdf or
word or txt, one paragraph per day). To get started, you can try answering
the questions: "Why is this important? How can it improve my research work?"
However any other personal reflection is welcome. Evaluation criteria: we
Expand Down
21 changes: 9 additions & 12 deletions content/exercises.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,26 @@ title = "List of exercises"

## List of exercises

### Week 1

Day 1:
Day 1, morning:
- [Copy and browse an existing project](https://coderefinery.github.io/git-intro/browsing/#exercise)
- [Committing changes](https://coderefinery.github.io/git-intro/commits/#exercise)
- [Merging changes and contributing to the project](https://coderefinery.github.io/git-intro/merging/#exercise)

Day 2:
Day 1, afternoon:
- [Cloning a Git repository and working locally](https://coderefinery.github.io/git-intro/local-workflow/#exercise)
- [Inspecting history](https://coderefinery.github.io/git-intro/archaeology/#exercise)
- [How to turn your project to a Git repo and share it](https://coderefinery.github.io/git-intro/sharing/#exercise)

Day 3:
Day 2, morning:
- [Collaborating within the same repository](https://coderefinery.github.io/git-collaborative/same-repository/#exercise)
- [Practicing code review](https://coderefinery.github.io/git-collaborative/code-review/#exercise)
- [How to contribute changes to repositories that belong to others](https://coderefinery.github.io/git-collaborative/forking-workflow/#exercise)

Day 2, afternoon:
- TBA

### Week 2

In week 2, the instructors will go through exercises on stream and invite
learners to participate with questions using the collaborative document.
Day 3, morning:
- TBA

We will not switch between lectures and group exercise sessions in week 2. For
groups that wish to go through exercises on their own, we recommend to schedule
separate sessions for this.
Day 3, afternoon:
- TBA
4 changes: 0 additions & 4 deletions content/links.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,8 @@

### Summary of important links

- Watch the stream at [https://twitch.tv/coderefinery](https://twitch.tv/coderefinery) (shareable)
- [Archive of past communication to participants](@/communication/_index.md) (shareable)
- Q&A of each day is archived on [this page](@/questions/_index.md) (shareable)
- Videos [on Twitch](https://www.twitch.tv/coderefinery/videos) for 7 days
and [on
YouTube](https://www.youtube.com/playlist?list=PLpLblYHCzJADIsbUhXSrC0qW5wDsH-F9U) later
- Install instructions: <https://coderefinery.github.io/installation/>
- Lesson material is linked in the schedule below (shareable)
- Collaborative document for questions and notes (please register to receive it)
16 changes: 2 additions & 14 deletions content/registration.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
+++
+++

**There is no deadline** and you are welcome to register and join even after
the event started. **You can attend just those days or sessions you want** but
please register anyway.

**Should all in a team sign up? Or only one person?** We recommend that all
register so that they get all necessary information.

**If you want to join as organization** to provide local helpers or in-person
sessions, please do! This usually takes the form of a "watching party" with
coordinated breaks for exercises.

**Some organizations offer their own registration form**. In this case please
register with them and then you do not have to register here centrally as well.
We will then make sure that everybody gets all necessary information.
**Before signing up** please also read [this privacy note about tools/services
we use](requirements/#privacy-and-tools-online-services). You may register for parts of the workshop if you wish. Please find the detailed schedule below.
6 changes: 2 additions & 4 deletions content/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,15 @@ title = "Prerequisites and software requirements"
course independent of a specific programming language and relevant for all
languages (but it is a process and not all material is completely generic
yet).
- Read [how to attend a livestream course](https://coderefinery.github.io/manuals/how-to-attend-stream/).
- Printing [this Git
cheatsheet](https://aaltoscicomp.github.io/cheatsheets/git-the-way-you-need-it-cheatsheet.pdf)
would be helpful - it was made by us and we'll refer to it.


## Preparation (software installation)

It takes a bit of time to install and configure the required software but with
500 or more participants it is not doable to debug these during the workshop
and we ask you to install and configure these **before you arrive at the
It takes a bit of time to install and configure the required software. We
ask you to install and configure these **before you arrive at the
workshop** following the instructions and checklist on [this
page](https://coderefinery.github.io/installation/).

Expand Down
Loading