Skip to content

Commit 98f090e

Browse files
authored
Update start course button (#379)
* Update start course button Update start course button based on new feature: https://github.blog/changelog/2023-04-27-pre-fill-form-fields-when-creating-a-new-repo/ * Update README.md * Update README.md * Update README.md
1 parent a7ce353 commit 98f090e

File tree

1 file changed

+44
-38
lines changed

1 file changed

+44
-38
lines changed

README.md

Lines changed: 44 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<!--
2-
<<< Author notes: Header of the course >>>
1+
<!--
2+
<<< Author notes: Header of the course >>>
33
Include a 1280×640 image, course title in sentence case, and a concise description in emphasis.
44
In your repository settings: enable template repository, add your 1280×640 social image, auto delete head branches.
55
Add your open source license, GitHub uses Creative Commons Attribution 4.0 International.
@@ -9,8 +9,8 @@
99

1010
_Get started using GitHub in less than an hour._
1111

12-
<!--
13-
<<< Author notes: Start of the course >>>
12+
<!--
13+
<<< Author notes: Start of the course >>>
1414
Include start button, a note about Actions minutes,
1515
and tell the learner why they should take the course.
1616
Each step should be wrapped in <details>/<summary>, with an `id` set.
@@ -31,28 +31,34 @@ People use GitHub to build some of the most advanced technologies in the world.
3131

3232
**Course tips:**
3333

34-
* Glossary terms will be _emphasised_ and linked to their definition.
34+
* Glossary terms will be _emphasised_ and linked to their definition.
3535

3636
## How to start this course
3737

38+
<!-- For start course, run in JavaScript:
39+
'https://github.com/new?' + new URLSearchParams({
40+
template_owner: 'skills',
41+
template_name: 'introduction-to-github',
42+
owner: '@me',
43+
name: 'skills-introduction-to-github',
44+
description: 'My clone repository',
45+
visibility: 'public',
46+
}).toString()
47+
-->
48+
49+
[![start-course](https://user-images.githubusercontent.com/1221423/235727646-4a590299-ffe5-480d-8cd5-8194ea184546.svg)](https://github.com/new?template_owner=skills&template_name=introduction-to-github&owner=%40me&name=skills-introduction-to-github&description=My+clone+repository&visibility=public)
50+
3851
1. Right-click **Start course** and open the link in a new tab.
39-
40-
[![start-course](https://user-images.githubusercontent.com/1221423/218596841-0645fe1a-4aaf-4f51-9ab3-8aa2d3fdd487.svg)](https://github.com/skills/introduction-to-github/generate)
41-
4252
2. In the new tab, follow the prompts to create a new repository.
43-
4453
- For owner, choose your personal account or an organization to host the repository.
4554
- We recommend creating a public repository—private repositories will [use Actions minutes](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions).
46-
- Name the repository something easy for you to recognize and remember.
47-
48-
![Create a new repository](/images/create-new-repository.png)
49-
50-
3. After your new repository is created, wait about 20 seconds, then refresh your new repository page. Follow the step-by-step instructions in the new repository's README. [GitHub Actions](https://docs.github.com/en/actions) will automatically close this welcome and open the first step.
55+
- Press the **Create repository** button at the bottom of the form.
56+
3. After your new repository is created, wait about 20 seconds, then refresh the page. Follow the step-by-step instructions in the new repository's README.
5157

5258
</details>
5359

54-
<!--
55-
<<< Author notes: Step 1 >>>
60+
<!--
61+
<<< Author notes: Step 1 >>>
5662
Choose 3-5 steps for your course.
5763
The first step is always the hardest, so pick something easy!
5864
Link to docs.github.com for further explanations.
@@ -83,26 +89,26 @@ Branches allow you to separate your work from the `main` branch. In other words,
8389
2. Navigate to the **< > Code** tab in the header menu of your repository.
8490

8591
![code-tab](/images/code-tab.png)
86-
92+
8793
3. Click on the **main** branch drop-down.
8894

8995
![main-branch-dropdown](/images/main-branch-dropdown.png)
90-
96+
9197
4. In the field, enter a name for your branch: `my-first-branch`.
9298
5. Click **Create branch: my-first-branch** to create your branch.
9399

94100
![create-branch-button](/images/create-branch-button.png)
95-
96-
The branch will automatically switch to the one you have just created.
101+
102+
The branch will automatically switch to the one you have just created.
97103
The **main** branch drop-down bar will reflect your new branch and display the new branch name.
98-
104+
99105
6. Move on to Step 2!
100106

101107
**Note**: If you made a public repository, and want to confirm you correctly set up your first branch, 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 close this step and open the next one.
102108

103109
</details>
104110

105-
<!--
111+
<!--
106112
<<< Author notes: Step 2 >>>
107113
Start this step by acknowledging the previous step.
108114
Define terms and link to docs.github.com.
@@ -119,42 +125,42 @@ Creating a branch allows you to edit your project without changing the `main` br
119125

120126
### :keyboard: Activity: Your first commit
121127

122-
The following steps will guide you through the process of committing a change on GitHub. A commit records changes in renaming, changing content within, creating a new file, and any other changes made to your project. For this exercise, committing a change requires first adding a new file to your new branch.
128+
The following steps will guide you through the process of committing a change on GitHub. A commit records changes in renaming, changing content within, creating a new file, and any other changes made to your project. For this exercise, committing a change requires first adding a new file to your new branch.
123129

124130
1. On the **< > Code** tab in the header menu of your repository, make sure you're on your new branch `my-first-branch`.
125131

126132
2. Select the **Add file** drop-down and click **Create new file**.
127133

128134
![create new file option](/images/create-new-file.png)
129-
135+
130136
3. In the **Name your file...** field, enter `PROFILE.md`.
131137

132138
**Note:** `.md` is a file extension that creates a Markdown file. You can learn more about Markdown by visiting "[Basic writing and formatting syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)" in our docs or by taking the "[Communicating using Markdown](https://github.com/skills/communicate-using-markdown)" Skills course.
133-
139+
134140
4. In the **Edit new file** area, copy the following content to your file:
135141

136142
```
137143
Welcome to my GitHub profile!
138144
```
139-
145+
140146
<img alt="profile.md file screenshot" src="/images/my-profile-file.png"/>
141-
147+
142148
5. For commits, you can enter a short commit message that describes what changes you made. This message helps others know what's included in your commit. GitHub offers a simple default message, but let's change it slightly for practice. First, enter `Add PROFILE.md` in the first text-entry field below **Commit new file** at the bottom of the page. Then, if you want to confirm what your screen should look like, expand the dropdown below.
143149

144150
<details>
145151
<summary> Expand to see the screenshot.</summary>
146152
<img alt="screenshot of adding a new file with a commit message" src="/images/commit-full-screen.png" />
147153
</details>
148-
154+
149155
6. In this lesson, we'll ignore the other fields and click **Commit new file**.
150156
7. Move on to Step 3!
151157

152158
**Note**: Like before, you can wait about 20 seconds, then refresh this page (the one you're following instructions from) and [GitHub Actions](https://docs.github.com/en/actions) will automatically close this step and open the next one.
153159

154160
</details>
155161

156-
<!--
157-
<<< Author notes: Step 3 >>>
162+
<!--
163+
<<< Author notes: Step 3 >>>
158164
Just a historic note: the previous version of this step forced the learner
159165
to write a pull request description,
160166
checked that `main` was the receiving branch,
@@ -184,24 +190,24 @@ To create a pull request automatically, click **Compare & pull request**, and th
184190
4. Select the **compare:** dropdown, and click `my-first-branch`.
185191

186192
<img alt="screenshot showing both branch selections" src="/images/pull-request-branches.png" />
187-
193+
188194
5. Click **Create pull request**.
189195
6. Enter a title for your pull request. By default, the title will automatically be the name of your branch. For this exercise, let's edit the field to say `Add my first file`.
190196
7. The next field helps you provide a description of the changes you made. Here, you can add a description of what you’ve accomplished so far. As a reminder, you have: created a new branch, created a file, and made a commit.
191197

192198
<img alt="screenshot showing pull request" src="/images/Pull-request-description.png" />
193-
199+
194200
8. Click **Create pull request**. You will automatically be navigated to your new pull request.
195201
9. Move on to Step 4!
196202

197203
**Note**: Like before, you can wait about 20 seconds, then refresh this page (the one you're following instructions from) and [GitHub Actions](https://docs.github.com/en/actions) will automatically close this step and open the next one. As a perk, you may see evidence of GitHub Actions running on the tab with the pull request opened! The image below shows a line you might see on your pull request after the Action finishes running.
198-
204+
199205
<img alt="screenshot of an example of an actions line" src="/images/Actions-to-step-4.png"/>
200206

201207
</details>
202208

203-
<!--
204-
<<< Author notes: Step 4 >>>
209+
<!--
210+
<<< Author notes: Step 4 >>>
205211
Just a historic note: The previous version of this step required responding
206212
to a pull request review before merging. The previous version also handled
207213
if users accidentally closed without merging.
@@ -227,15 +233,15 @@ As noted in the previous step, you may have seen evidence of GitHub Actions runn
227233
3. Once your branch has been merged, you don't need it anymore. To delete this branch, click **Delete branch**.
228234

229235
<img alt="screenshot showing delete branch button" src="/images/delete-branch.png"/>
230-
236+
231237
4. Check out the **Finish** step to see what you can learn next!
232238

233239
**Note**: Like before, you can wait about 20 seconds, then refresh this page (the one you're following instructions from) and [GitHub Actions](https://docs.github.com/en/actions) will automatically close this step and open the next one.
234240

235241
</details>
236242

237-
<!--
238-
<<< Author notes: Finish >>>
243+
<!--
244+
<<< Author notes: Finish >>>
239245
Review what we learned, ask for feedback, provide next steps.
240246
-->
241247

0 commit comments

Comments
 (0)