Skip to content

Commit f9825dc

Browse files
feat: Migrate exercise to issue-based flow (skills#274)
* feat: Initial migration with draft content (github-education-experiences#1) * Add readme and start exercise workflow * fix: remove extra file * feat: Add draft step 1 * feat: Add draft step 2 * feat: Add draft step 3 * fix: typos * feat: Add draft step 4 * feat: Add draft step 5 and review * feat: Reorder steps 2 and 4 * feat: Rename blog-day-1.md to day-1.md * feat: Add missing links * feat: Wording adjustements from review * feat: Change copy exercise URL * feat: Rename step 1 files * chore: Bump exercise toolkit version * fix: incorrect workflow name * feat: Add paths filter to triggers * feat: Show checking work as new comment * fix: incorrect variable name * chore: Wording tweaks * feat: Add help to end of each step * fix: Remove paths filter from start exercise * chore: wording tweaks from practice run * fix: The `-` symbol seems to be unsupported by action-keyphrase-checker * fix: incorrect file name * fix: incorrect grading check * fix: broken step 5 workflow * chore: Wording tweaks * Minor wording tweaks * Minor wording tweaks after test run * chore: Wording tweak * fix: Change copy exercise url to skills org --------- Co-authored-by: Aleksander Fidelus <63016446+FidelusAleksander@users.noreply.github.com>
1 parent 1921cfb commit f9825dc

23 files changed

+991
-646
lines changed

.github/steps/-step.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

.github/steps/0-welcome.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

.github/steps/1-add-headers.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

.github/steps/1-add-headings.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
## Step 1: Add headings
2+
3+
**What is _Markdown_?** Markdown is a [lightweight syntax](https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for communicating on GitHub. You can format text to add a heading, lists, **bold**, _italics_, tables, and many other stylings. You can use Markdown in most places around GitHub such as:
4+
5+
- Comments on [issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues), [pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests), and [discussions](https://docs.github.com/discussions/collaborating-with-your-community-using-discussions/about-discussions)
6+
- Files with the `.md` or `.markdown` extension
7+
- Snippets of text in [Gists](https://docs.github.com/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists)
8+
9+
**What is a _heading_?** A heading is a larger bit of text at the beginning of a section. There are six sizes.
10+
11+
### Example
12+
13+
```md
14+
# This is an `<h1>` heading, which is the largest
15+
16+
## This is an `<h2>` heading
17+
18+
###### This is an `<h6>`heading, which is the smallest
19+
```
20+
21+
# This is an `<h1>` heading, which is the largest
22+
23+
## This is an `<h2>` heading
24+
25+
###### This is an `<h6>` heading, which is the smallest
26+
27+
### ⌨️ Activity: Create a mardkown file
28+
29+
1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab.
30+
31+
1. In the top navigation, select the **Code** tab.
32+
33+
1. Create a new branch with the following name:
34+
35+
```md
36+
start-blog
37+
```
38+
39+
1. Above the files list, click the **Add file** button and select **Create new file**.
40+
41+
1. Use the following file name.
42+
43+
```md
44+
day-1.md
45+
```
46+
47+
1. In the editor, on the first line use a level one heading to give the page a title.
48+
49+
```md
50+
# Daily Learning
51+
```
52+
53+
1. Add a couple level 2 headings for the names of each of the blog posts.
54+
55+
```md
56+
## Morning Planning
57+
58+
## Review
59+
```
60+
61+
1. Above the editor, click the **Preview** toggle to view the rendered version.
62+
63+
1. In the top right, click the **Commit changes** button and commit directly to the `start-blog` branch.
64+
65+
1. With our headings created and committed, Mona should be busy reviewing your work and preparing the next steps.
66+
67+
<details>
68+
<summary>Having trouble? 🤷</summary><br/>
69+
70+
- Confirm you are editing the correct file and branch.
71+
- Double check your syntax. The must be a space between the `#` and first word.
72+
73+
</details>

.github/steps/2-add-an-image.md

Lines changed: 0 additions & 29 deletions
This file was deleted.
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
## Step 2: Make a list
2+
3+
Markdown supports 3 types of common lists. They include:
4+
5+
- [Unordered](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists) - Bulleted list
6+
- [Ordered](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists) - Number list
7+
- [Task](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#task-lists) - Checkbox list
8+
9+
### Unordered list
10+
11+
An unordered list is simple to show. Each item is placed on its own line using a `-`, `*`, or `+` character.
12+
13+
```md
14+
- Item 1
15+
- Item 2
16+
- Item 3
17+
```
18+
19+
- Item 1
20+
- Item 2
21+
- Item 3
22+
23+
### Ordered List
24+
25+
A list is changed to ordered by using any number instead of the list character. Notice how markdown automatically handles the counting. Nice!
26+
27+
```md
28+
1. Step 1
29+
1. Step 2
30+
1. Step 3
31+
```
32+
33+
1. Step 1
34+
1. Step 2
35+
1. Step 3
36+
37+
### Task List
38+
39+
A task list is extends the unordered list to use check boxes.
40+
Add empty brackets `[ ]` for incomplete tasks and filled brackets `[x]` for complete tasks. Note: The empty required space for empty brackets.
41+
42+
```md
43+
- [x] This task is complete
44+
- [ ] This task is not complete
45+
```
46+
47+
- [x] This task is complete
48+
- [ ] This task is not complete
49+
50+
> [!TIP]
51+
> Issues and pull requests can use task syntax for [conveying progress](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-tasklists).
52+
53+
### :keyboard: Activity: Add ideas and goals to our morning plan
54+
55+
1. On the `start-blog` branch, open the `day-1.md` file for editing.
56+
57+
1. Add the following task list below **morning planning** level two heading to track goals you want to achieve.
58+
59+
```md
60+
- [ ] Check out the [github blog](https://github.blog/) for topic ideas.
61+
- [ ] Learn about [GitHub Pages](https://skills.github.com/#first-day-on-github).
62+
- [ ] Convert my first blog post into an actual webpage.
63+
```
64+
65+
1. Use the **Preview** tab to check your Markdown formatting.
66+
67+
1. In the top right, click the **Commit changes** button and commit directly to the `start-blog` branch.
68+
69+
1. With our code block committed, Mona should be busy reviewing your work and preparing the next steps.
70+
71+
<details>
72+
<summary>Having trouble? 🤷</summary><br/>
73+
74+
- Confirm you are editing the correct file and branch.
75+
- Double check your syntax. The must be a space inside the `[ ]` for task lists.
76+
77+
</details>
Lines changed: 40 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,58 @@
1-
<!--
2-
<<< Author notes: Step 3 >>>
3-
Start this step by acknowledging the previous step.
4-
Define terms and link to docs.github.com.
5-
-->
1+
## Step 3: Add a code sample
62

7-
## Step 3: Add a code example
3+
Let's learn about [code blocks](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code) and [syntax highlighting](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) based on the language.
84

9-
_Great job adding an image to the file :tada:_
5+
> [!TIP]
6+
> Many programming languages are supported. Try testing out some other file extension types!
107
11-
Let's add some code blocks. Code blocks can render differently depending on the language.
8+
### Example: Terminal Command
129

13-
### Example 1
14-
15-
<pre>
16-
```
17-
$ git init
18-
Initialized empty Git repository in /Users/skills/Projects/recipe-repository/.git/
10+
````md
11+
```bash
12+
git clone https://github.com/skills/communicate-using-markdown
1913
```
20-
</pre>
14+
````
2115

22-
#### How it looks
23-
24-
```
25-
$ git init
26-
Initialized empty Git repository in /Users/skills/Projects/recipe-repository/.git/
16+
```bash
17+
git clone https://github.com/skills/communicate-using-markdown
2718
```
2819

29-
### Example 2
20+
### Example: Javascript Code
3021

31-
<pre>
32-
``` javascript
22+
````md
23+
```js
3324
var myVar = "Hello, world!";
3425
```
35-
</pre>
26+
````
3627

37-
#### How it looks
38-
39-
```javascript
28+
```js
4029
var myVar = "Hello, world!";
4130
```
4231

4332
### :keyboard: Activity: Adding a code example
4433

45-
1. As you did before, edit the file in this pull request.
46-
1. In the file, add the correct Markdown for a code example of your choice.
34+
1. On the `start-blog` branch, open the `day-1.md` file for editing.
35+
36+
1. Below **Review** level two heading add the following entry recording an awesome code snippet you just learned from the GitHub Blog.
37+
38+
````md
39+
Convert an image or video from dark mode to light mode using [ffmpeg](https://www.ffmpeg.org)
40+
41+
```bash
42+
ffmpeg -i input.mp4 -vf "negate,hue=h=180,eq=contrast=1.2:saturation=1.1" output.mp4
43+
```
44+
````
45+
4746
1. Use the **Preview** tab to check your Markdown formatting.
48-
1. Commit your changes.
49-
1. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.
47+
48+
1. In the top right, click the **Commit changes** button and commit directly to the `start-blog` branch.
49+
50+
1. With our code block committed, Mona should be busy reviewing your work and preparing the next steps.
51+
52+
<details>
53+
<summary>Having trouble? 🤷</summary><br/>
54+
55+
- Confirm you are editing the correct file and branch.
56+
- Double check your syntax. A code block is three backticks ` ``` ` not three apostrophes `'''`
57+
58+
</details>

0 commit comments

Comments
 (0)