docs: 📝 add exercises #24

signekb · 2025-01-19T20:17:20Z

Description

This PR adds exercises. Somehow, it ended up with four exercises, which might be too much. What do you think?

Related to #10

This PR needs an in-depth review.

Checklist

Formatted Markdown
Ran just run-all

sessions/lesson.qmd

signekb · 2025-01-19T20:19:55Z

sessions/lesson.qmd

+First, we want to add a file to the repository.
+
+1.  Go to the repository on GitHub.
+2.  In the code tab, click "Add file" and then "Create new file".
+3.  In the "Name your file..." field, type a name for your file. For
+    simplicity, let's call it your name and make it a Markdown file. For
+    example, "your-name.md".
+4.  Click the green "Commit changes" button and fill in the commit
+    message. For example, "Add file with my name". You don't need to
+    fill in the extended description. Keep the "Commit directly to the
+    `main` branch" option selected.
+5.  When you have filled in the commit message, click the green "Commit
+    changes" button.
+6.  Go back to the repository and check that your file has been added.
+
+You have now made your first commit to the repository! :tada:


I guess this could be a part of the code along instead?

Yea, these steps could be, but the basic steps can stay the same. See comment above about "problem to solve"

For now, I have kept everything as exercises. Then we can move them to the different lessons and change them accordingly there.

lwjohnst86

Nice start! Some comments ☺️

lwjohnst86 · 2025-01-22T08:03:45Z

sessions/lesson.qmd

+## Exercise: Add a new file and modify the content
+
+First, we want to add a file to the repository.


Follow the format of the vscode snippet exercise to match the other websites ☺️

It helps that exercises have some problem to solve rather than "do this", "but why", "because". Maybe it could be like the exercises you thought of for git4cats, where we get them to find a recipe they like and put it on the repo as a new file.

I've gone all out with the recipes / recipe book now 🍰 🍪

sessions/lesson.qmd

lwjohnst86 · 2025-01-22T08:15:17Z

sessions/lesson.qmd

+First, we want to add a file to the repository.
+
+1.  Go to the repository on GitHub.
+2.  In the code tab, click "Add file" and then "Create new file".
+3.  In the "Name your file..." field, type a name for your file. For
+    simplicity, let's call it your name and make it a Markdown file. For
+    example, "your-name.md".
+4.  Click the green "Commit changes" button and fill in the commit
+    message. For example, "Add file with my name". You don't need to
+    fill in the extended description. Keep the "Commit directly to the
+    `main` branch" option selected.
+5.  When you have filled in the commit message, click the green "Commit
+    changes" button.
+6.  Go back to the repository and check that your file has been added.
+
+You have now made your first commit to the repository! :tada:


Yea, these steps could be, but the basic steps can stay the same. See comment above about "problem to solve"

sessions/lesson.qmd

lwjohnst86

Very nice!! I've made lots of suggestions 😁 🎉

lwjohnst86 · 2025-02-14T14:02:07Z

sessions/lesson.qmd

@@ -20,7 +20,285 @@ Specific learning objectives are:
 TODO: Reading text
 :::

-## Exercise: TODO: Add title
+## :woman_technologist: Exercise: Add a cookie recipe to the repository {#sec-add-recipe-file}


Suggested change

## :woman_technologist: Exercise: Add a cookie recipe to the repository {#sec-add-recipe-file}

## :woman_technologist: Exercise: Add a cookie recipe to your repository

It isn't necessary to add the sec tags unless you reference them elsewhere. Which we generally don't

lwjohnst86 · 2025-02-14T14:02:36Z

sessions/lesson.qmd

+
+{{< text_snippet sticky_up >}}
+
+## :technologist: Exercise: Add the cookie recipe to `cookie-recipe.md` file {#sec-add-recipe-content}


Suggested change

## :technologist: Exercise: Add the cookie recipe to `cookie-recipe.md` file {#sec-add-recipe-content}

## :technologist: Exercise: Add the cookie recipe to `cookie-recipe.md` file

lwjohnst86 · 2025-02-14T14:04:36Z

sessions/lesson.qmd

+
+Let's add the first recipe to your repository: A cookie recipe! :cookie:
+
+First, we want to add a file that will include the recipe to the


Suggested change

First, we want to add a file that will include the recipe to the

First, we want to add a file that will include the recipe to your

lwjohnst86 · 2025-02-14T14:04:54Z

sessions/lesson.qmd

+First, we want to add a file that will include the recipe to the
+repository.
+
+1.  Go to the repository on GitHub.


Suggested change

1. Go to the repository on GitHub.

lwjohnst86 · 2025-02-14T14:05:19Z

sessions/lesson.qmd

+repository.
+
+1.  Go to the repository on GitHub.
+2.  In the code tab, click "Add file" and then "Create new file".


Suggested change

2. In the code tab, click "Add file" and then "Create new file".

1. In the "Code" tab of your repository, click "Add file" and then "Create new file".

lwjohnst86 · 2025-02-14T17:21:51Z

sessions/lesson.qmd

+::: {.callout-note collapse="true"}
+## :teacher: Instructor note
+
+Before starting this exercise, make sure that the learners have added
+their neighbour as collaborators to their repositories. If they haven't,
+they can do so by going to the repository, clicking on "Settings", then
+"Collaborators and teams", and then "Add people".
+:::


This could be a task in the exercise, depending on how the content before is structured. For now, this is good!

lwjohnst86 · 2025-02-14T17:24:50Z

sessions/lesson.qmd

+2.  As we did in @sec-add-recipe-file and @sec-add-recipe-content , add
+    a new file with a recipe - this time, it's just in another person's
+    repository. For example, you could add a brownie recipe like the one
+    below:


Suggested change

2. As we did in @sec-add-recipe-file and @sec-add-recipe-content , add

a new file with a recipe - this time, it's just in another person's

repository. For example, you could add a brownie recipe like the one

below:

2. As we've done during this workshop, add

a new file with a recipe, naming the file by using the recipe name (remember the correct naming for files!).

This time, you will be adding the file to your

neighbour's repository. In the file, add a recipe of your choice.

For convenience, you can also use the brownie recipe below:

lwjohnst86 · 2025-02-14T17:25:29Z

sessions/lesson.qmd

+    5. Pour the mixture into a baking tray and bake at 170°C for 30-35 minutes.
+    ```
+
+3.  Commit the changes as we have done it previously and go to the


Suggested change

3. Commit the changes as we have done it previously and go to the

3. Commit the changes as you have done previously in the workshop. Then go to the neighbour's

lwjohnst86 · 2025-02-14T17:26:38Z

sessions/lesson.qmd

+## :woman_technologist: Exercise: See the changes in the repository
+
+> Time: \~10 minutes.
+
+After you have made the changes, go back to the repository and click the
+History button to see the changes that have been made (including your
+own and the changes made by others).
+
+{{< text_snippet sticky_up >}}


Hmm, not sure this is necessary as an exercise. Unless it is re-written to be about a problem/finding something. We already have lots of exercises, so I think it's fine to delete.

Suggested change

## :woman_technologist: Exercise: See the changes in the repository

> Time: \~10 minutes.

After you have made the changes, go back to the repository and click the

History button to see the changes that have been made (including your

own and the changes made by others).

{{< text_snippet sticky_up >}}

lwjohnst86 · 2025-02-14T17:27:41Z

sessions/lesson.qmd

+## :woman_technologist: Exercise: Cleaning up
+
+> Time: \~10 minutes.
+
+Now, let's close the "Future recipes" issue you created earlier.
+
+1.  Go to the "Issues" tab in your repository.
+2.  Click on the issue you created.
+3.  In the comment field, write a comment about why you are closing the
+    issue. For example, you could write "This issue has been resolved"
+    or "I have now added all the relevant recipes from this issue".
+    Then, click the "Close issue" button.
+
+Lastly, let's delete the `chocolate-chip-cookies.md` file along with the
+`cookies` folder you created earlier:
+
+1.  Go to the file.
+2.  On the same line as the file name, click the button with the three
+    dots, saying "More file actions". Click it, scroll down and click
+    "Delete file".
+3.  Commit the changes.
+4.  Now, go the `cookies` folder and delete it in the same way as you
+    deleted the `chocolate-chip-cookies.md` file. For folders, it will
+    say "Delete directory" instead of "Delete file".
+
+{{< text_snippet sticky_up >}}


Suggested change

## :woman_technologist: Exercise: Cleaning up

> Time: \~10 minutes.

Now, let's close the "Future recipes" issue you created earlier.

1. Go to the "Issues" tab in your repository.

2. Click on the issue you created.

3. In the comment field, write a comment about why you are closing the

issue. For example, you could write "This issue has been resolved"

or "I have now added all the relevant recipes from this issue".

Then, click the "Close issue" button.

Lastly, let's delete the `chocolate-chip-cookies.md` file along with the

`cookies` folder you created earlier:

1. Go to the file.

2. On the same line as the file name, click the button with the three

dots, saying "More file actions". Click it, scroll down and click

"Delete file".

3. Commit the changes.

4. Now, go the `cookies` folder and delete it in the same way as you

deleted the `chocolate-chip-cookies.md` file. For folders, it will

say "Delete directory" instead of "Delete file".

{{< text_snippet sticky_up >}}

Given we already have lots of exercises, and that this is a low priority/low value exercise, let's just delete it.

docs: 📝 add exercises

8c5eb23

signekb requested a review from lwjohnst86 as a code owner January 19, 2025 20:17

github-actions bot assigned signekb Jan 19, 2025

signekb commented Jan 19, 2025

View reviewed changes

sessions/lesson.qmd Outdated Show resolved Hide resolved

signekb commented Jan 19, 2025

View reviewed changes

sessions/lesson.qmd Outdated Show resolved Hide resolved

signekb commented Jan 19, 2025

View reviewed changes

signekb added 2 commits January 19, 2025 21:32

docs: ✏️ txt -> md

1a9e59a

docs: 📝 add file deletion in exercise

a164603

lwjohnst86 requested changes Jan 22, 2025

View reviewed changes

signekb added 2 commits February 14, 2025 13:33

docs: 🎨 use exercise snippet to match other websites

907a33f

docs: ♻️ rewrite exercises with recipe context 🍪 🍰

1a6e050

signekb requested a review from lwjohnst86 February 14, 2025 13:47

lwjohnst86 requested changes Feb 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: 📝 add exercises #24

docs: 📝 add exercises #24

signekb commented Jan 19, 2025 •

edited by lwjohnst86

Loading

signekb Jan 19, 2025

lwjohnst86 Jan 22, 2025

signekb Feb 14, 2025

lwjohnst86 left a comment

lwjohnst86 Jan 22, 2025

lwjohnst86 Jan 22, 2025

signekb Feb 14, 2025

lwjohnst86 Jan 22, 2025

lwjohnst86 left a comment

lwjohnst86 Feb 14, 2025

lwjohnst86 Feb 14, 2025

lwjohnst86 Feb 14, 2025

lwjohnst86 Feb 14, 2025

lwjohnst86 Feb 14, 2025

lwjohnst86 Feb 14, 2025

lwjohnst86 Feb 14, 2025

lwjohnst86 Feb 14, 2025

lwjohnst86 Feb 14, 2025

lwjohnst86 Feb 14, 2025

		## Exercise: Add a new file and modify the content

		First, we want to add a file to the repository.

	## :woman_technologist: Exercise: Add a cookie recipe to the repository {#sec-add-recipe-file}
	## :woman_technologist: Exercise: Add a cookie recipe to your repository


		{{< text_snippet sticky_up >}}

		## :technologist: Exercise: Add the cookie recipe to `cookie-recipe.md` file {#sec-add-recipe-content}


		Let's add the first recipe to your repository: A cookie recipe! :cookie:

		First, we want to add a file that will include the recipe to the

	2. In the code tab, click "Add file" and then "Create new file".
	1. In the "Code" tab of your repository, click "Add file" and then "Create new file".

-.  As we did in @sec-add-recipe-file and @sec-add-recipe-content , add
-    a new file with a recipe - this time, it's just in another person's
-    repository. For example, you could add a brownie recipe like the one
-    below:
+.  As we've done during this workshop, add
+    a new file with a recipe, naming the file by using the recipe name (remember the correct naming for files!).
+    This time, you will be adding the file to your
+    neighbour's repository. In the file, add a recipe of your choice.
+    For convenience, you can also use the brownie recipe below:

	3. Commit the changes as we have done it previously and go to the
	3. Commit the changes as you have done previously in the workshop. Then go to the neighbour's

docs: 📝 add exercises #24

Are you sure you want to change the base?

docs: 📝 add exercises #24

Conversation

signekb commented Jan 19, 2025 • edited by lwjohnst86 Loading

Description

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lwjohnst86 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lwjohnst86 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

signekb commented Jan 19, 2025 •

edited by lwjohnst86

Loading