Skip to content

Commit ab4586c

Browse files
authored
Enhance lesson content with pull request workflow details
Added a section explaining the pull request workflow and how to visualize prerequisites in lesson content. Included a screenshot example of the rendered lesson prerequisite fenced div.
1 parent 47b8857 commit ab4586c

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

episodes/lesson-content.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ as a bullet list in the `index.md` file of your lesson repository.
7171
::::::::::::::::::::::::::::::::::::::::::::::::::
7272

7373
Below those, let's add the prerequisite skills you determined earlier for your lesson.
74+
This time, instead of committing directly to the `main` branch - we will save our changes on another branch and then do a pull request to merge them to `main` that will allow us to review and spot any issues.
7475

7576
## Proposing Changes with Pull Requests
7677

@@ -133,13 +134,6 @@ Since a more in-depth discussion of pull request reviews is included in the GitH
133134

134135
:::::::::::::::::::::::::::::::::::::::::::::::
135136

136-
Once the changes have been merged and your lesson site rebuilds, check how prerequisites block appears on your lesson's home page.
137-
A screenshot below provides an example.
138-
139-
![A rendered lesson prerequisite fenced div](fig/prereq-fenced-div.png){
140-
alt="Lesson prerequisite fenced div structural block as rendered in a Web page by the Workbench"
141-
}
142-
143137
You will have an opportunity to practice this pull request workflow in a moment.
144138

145139
We just added the prequisites as a bullet point list in `index.md`, but the Workbench provides a special formatted block for lesson prerequisites, so they appear visually distinct on the page.
@@ -160,6 +154,12 @@ Finally, end your fenced div with a closing tag consisting of at least 3 colons
160154
and we will explore most of them in this episode.
161155
:::
162156

157+
A screenshot below provides an example of how prerequisites block appears in a webpage.
158+
159+
![A rendered lesson prerequisite fenced div](fig/prereq-fenced-div.png){
160+
alt="Lesson prerequisite fenced div structural block as rendered in a Web page by the Workbench"
161+
}
162+
163163
:::::::::::::::::::::::::::::::::::::::: challenge
164164

165165
### Practice with Pull Requests (10 mins)
@@ -178,6 +178,9 @@ Edit `index.md`, following the steps demonstrated earlier to open a pull request
178178

179179
::::::::::::::::::::::::::::::::::::::::::::::::::
180180

181+
Once your changes have been merged and your lesson site rebuilds, check how prerequisites block appears on your lesson's home page.
182+
183+
181184
:::::::::::::::::::::::::::::::: spoiler
182185

183186
### Markdown Rendering on GitHub

0 commit comments

Comments
 (0)