A tutorial is made from a repository that includes three parts:
7
+
A tutorial is made from a repository that includes three parts:
8
8
9
9
1. Markdown
10
10
2. YAML
11
11
3. Git Commits
12
12
13
13
The Markdown and YAML live on the master branch of the repo, and the Git commits live on a version branch.
14
14
15
-
We'll go into each in detail in more detail.
15
+
We'll go into each parts in more detail.
Original file line number
Diff line number
Diff line change
@@ -51,11 +51,11 @@ This is the test text. Create an `index.html` file to pass this lesson.
51
51
52
52
The above tutorial has an introduction page and one lesson.
53
53
54
-
### Commit to
54
+
### Commit to
55
55
56
56
- Back in the terminal, add all your new files to be committed with `git add .`
57
57
- Commit them with `git commit -m "create markdown"`
58
-
- Push them to with `git push origin master`
58
+
- Push them to with `git push origin master`
59
59
60
60
### Create a version branch
61
61
@@ -68,7 +68,7 @@ This will make a branch that isn't created from master, so it has no commit hist
68
68
69
69
### Create your project files
70
70
71
-
This branch is also where users create their projects, modify files for a tutorial, and most anything they need to do.
71
+
This branch is also where users create their projects, modify files for a tutorial, and anything else that they need to do.
72
72
73
73
- Make a new folder named `coderoad` on your branch.
74
74
@@ -93,7 +93,7 @@ This folder will hold as much of the CodeRoad stuff as it can so users aren't co
93
93
94
94
```
95
95
96
-
These scripts will be for CodeRoad and you to test things.
96
+
These scripts will be for CodeRoad and for you to test things.
97
97
98
98
- From the terminal, in your `coderoad` folder, run `npm install --save mocha mocha-tap-reporter` to install some depenedencies
99
99
-**Go back to the main repo folder** and add your changes with `git add .`
@@ -162,11 +162,11 @@ That stands for "Lesson 1 Step 1 Setup & Tests". You can put an additional note
162
162
That stands for "Lesson 1 Step 1 Solution", and it's the solution to the test.
163
163
164
164
- Take a quick look at the commit history with `git log`. You can see the messages there, they align with the titles you put in the markdown and there's one commit for the test (`1.1`) and an optional commit for the solution (`1.1S`)
165
-
- Push your changes to with `git push origin v0.1.0`
165
+
- Push your changes to with `git push origin v0.1.0`
166
166
167
167
### Create the YAML file
168
168
169
-
- Go back your your master branch with `git checkout master`
169
+
- Go back to your master branch with `git checkout master`
170
170
You can think of these two branches like separate repositories, the branches will never merge and the files will always be different, even if some look the same.
171
171
- Create a new file named `coderoad.yaml` and add this to it:
172
172
@@ -193,14 +193,14 @@ levels:
193
193
- id: '1.1'
194
194
```
195
195
196
-
Replace the `repo uri` URL with your repo, note that it's just the username and repo in the URL. This file links everything together. You can see the repo URL and the branch that you created. And the `1.` and `1.1` id's that match the markdown. You can also add commands that will run when a lesson is started, as well as a host of other things.
196
+
Replace the `repo uri` URL with your repo, note that it's just the username and repo in the URL. This file links everything together. You can see the repo URL and the branch that you created. And the `1.` and `1.1` ID's that match the markdown. You can also add commands that will run when a lesson has started, as well as a host of other things.
197
197
198
198
- Add this with `git add .`
199
199
- Commit it with `git commit -m "create yaml"`
200
200
201
201
The commit messages on master can be whatever you want.
202
202
203
-
- Push it to with `git push origin master`
203
+
- Push it to with `git push origin master`
204
204
205
205
### Build the config.json file
206
206
@@ -259,7 +259,7 @@ Add the DOCTYPE
259
259
260
260
- Add all the files
261
261
- Commit the files with any message
262
-
- Push the changes to
262
+
- Push the changes to
263
263
264
264
### Add second lesson test
265
265
@@ -307,7 +307,7 @@ There should be one passing and one failing test
307
307
- Commit it with a message of "2.1"
308
308
- Add the `index.html` file to be committed
309
309
- Commit it with a message of "2.1S"
310
-
- Push your changes to to your `v0.1.0` branch
310
+
- Push your changes to to your `v0.1.0` branch
311
311
312
312
### Update the YAML
313
313
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,6 @@ A CodeRoad tutorial runs on Git commits. These will be the commits on the versio
19
19
20
20
Then repeat steps 2 & 3.
21
21
22
-
The commit messages for these must start with a level & step number. "1.1" stands for "Lesson 1 Step 1 Setup" and "1.1S" stand for "Lesson 1 Step 1 Solution". The `1.1` part of each commit message needs to match the id's from the markdown and yaml.
22
+
The commit messages for these must start with a level & step number. "1.1" stands for "Lesson 1 Step 1 Setup" and "1.1S" stand for "Lesson 1 Step 1 Solution". The `1.1` part of each commit message needs to match the ID's from the markdown and yaml.
23
23
24
24
You can add additional text after those required characters if you want.
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ Test text for 2.2
57
57
58
58
The example above has an introduction page and two lessons.
59
59
60
-
The introduction page is first thing users will see when they start a tutorial. It shows an overview of all the lessons and displays the lesson summary.
60
+
The introduction page is the first thing users will see when they start a tutorial. It shows an overview of all the lessons and displays the lesson summary.
61
61
62
62
Lessons need to start with `## x.` where `x` is the lesson number. The text after `x.` will display as the lesson title.
63
63
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,6 @@ Interactive learning is the most effective way to gain new skills and knowledge.
14
14
15
15
For learners, there are a number of advantages to running tutorials inside VSCode:
16
16
17
-
-learn in a real world coding environment
18
-
-get rapid feedback on save and helpful error messages
19
-
-users own the code, and can build a Git timeline and deploy a portfolio
17
+
-Learn in a real world coding environment
18
+
-Get rapid feedback on save and helpful error messages
19
+
-Users own the code, and can build a Git timeline and deploy a portfolio
Original file line number
Diff line number
Diff line change
@@ -22,8 +22,8 @@ Install CodeRoad from [this link in the VSCode Marketplace](https://marketplace.
22
22
23
23
To start the extension, inside VSCode:
24
24
25
-
-open an empty VSCode workspace (an empty folder)
26
-
-launch the app from the VSCode command palette:
27
-
-select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`
28
-
-in the command palette, search for and run `CodeRoad:Start`
29
-
-a webview should appear on the right side of your editor. Click "Start"
25
+
-Open an empty VSCode workspace (an empty folder)
26
+
-Launch the app from the VSCode command palette:
27
+
-Select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`
28
+
-In the command palette, search for and run `CodeRoad:Start`
29
+
-A webview should appear on the right side of your editor. Click "Start"
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ levels:
43
43
subtasks: false
44
44
```
45
45
46
-
Note that the id's for each lesson and step match the id's in the markdown.
46
+
Note that the ID's for each lesson and step matches the ID's in the markdown.
0 commit comments