Skip to content

Commit

Permalink
Revert "Updates to image pathing" (#719)
Browse files Browse the repository at this point in the history
* Revert "Updates to image pathing (#716)"

This reverts commit 36751c8.

* Use markdown syntax for images

![alt](path)
  • Loading branch information
sinsukehlab authored Apr 30, 2024
1 parent 36751c8 commit 86a4bea
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
8 changes: 4 additions & 4 deletions .github/steps/1-create-a-branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,23 @@ Branches allow you to separate your work from the `main` branch. In other words,

**What is a profile README?**: A _[profile README](https://docs.github.com/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)_ is essentially an "About me" section on your GitHub profile where you can share information about yourself with the community on GitHub.com. GitHub shows your profile README at the top of your profile page. For more information, see "[Managing your profile README](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)".

![profile-readme-example](../../images/profile-readme-example.png)
![profile-readme-example](/images/profile-readme-example.png)

### :keyboard: Activity: Your first branch

1. Open a new browser tab and navigate to your newly made repository. Then, work on the steps in your second tab while you read the instructions in this tab.
2. Navigate to the **< > Code** tab in the header menu of your repository.

![code-tab](../../images/code-tab.png)
![code-tab](/images/code-tab.png)

3. Click on the **main** branch drop-down.

![main-branch-dropdown](../../images/main-branch-dropdown.png)
![main-branch-dropdown](/images/main-branch-dropdown.png)

4. In the field, name your branch `my-first-branch`. In this case, the name must be `my-first-branch` to trigger the course workflow.
5. Click **Create branch: my-first-branch** to create your branch.

![create-branch-button](../../images/create-branch-button.png)
![create-branch-button](/images/create-branch-button.png)

The branch will automatically switch to the one you have just created.
The **main** branch drop-down bar will reflect your new branch and display the new branch name.
Expand Down
6 changes: 3 additions & 3 deletions .github/steps/2-commit-a-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The following steps will guide you through the process of committing a change on

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

![create new file option](../../images/create-new-file.png)
![create new file option](/images/create-new-file.png)

3. In the **Name your file...** field, enter `PROFILE.md`.

Expand All @@ -33,11 +33,11 @@ The following steps will guide you through the process of committing a change on
Welcome to my GitHub profile!
```

![profile.md file screenshot](../../images/my-profile-file.png)
![profile.md file screenshot](/images/my-profile-file.png")

5. Click **Commit changes...** in the upper right corner above the contents box. 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 titled "Commit message".

![screenshot of adding a new file with a commit message](../../images/commit-full-screen.png)
![screenshot of adding a new file with a commit message](/images/commit-full-screen.png")

6. In this lesson, we'll ignore the other fields and click **Commit changes**.
7. 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.
8 changes: 4 additions & 4 deletions .github/steps/3-open-a-pull-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Now that you have made a change to the project and created a commit, it’s time

You may have noticed after your commit that a message displayed indicating your recent push to your branch and providing a button that says **Compare & pull request**.

![screenshot of message and button](../../images/compare-and-pull-request.png)
![screenshot of message and button](/images/compare-and-pull-request.png)

To create a pull request automatically, click **Compare & pull request**, and then skip to step 6 below. If you don't click the button, the instructions below walk you through manually setting up the pull request.

Expand All @@ -27,18 +27,18 @@ To create a pull request automatically, click **Compare & pull request**, and th
3. In the **base:** dropdown, make sure **main** is selected.
4. Select the **compare:** dropdown, and click `my-first-branch`.

![screenshot showing both branch selections](../../images/pull-request-branches.png)
![screenshot showing both branch selections](/images/pull-request-branches.png")

5. Click **Create pull request**.
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`.
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.

![screenshot showing pull request](../../images/Pull-request-description.png)
![screenshot showing pull request](/images/Pull-request-description.png)

8. Click **Create pull request**. You will automatically be navigated to your new pull request.
9. 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.

> [!NOTE]
> 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.
>
> ![screenshot of an example of an actions line](../../images/Actions-to-step-4.png)
> ![screenshot of an example of an actions line](/images/Actions-to-step-4.png)
4 changes: 2 additions & 2 deletions .github/steps/4-merge-your-pull-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ You successfully created a pull request. You can now merge your pull request.

As noted in the previous step, you may have seen evidence of GitHub Actions running which automatically progresses your instructions to the next step. You'll have to wait for it to finish before you can merge your pull request. It will be ready when the merge pull request button is green.

![screenshot of green merge pull request button](../../images/Green-merge-pull-request.png)
![screenshot of green merge pull request button](/images/Green-merge-pull-request.png)

### :keyboard: Activity: Merge the pull request

1. Click **Merge pull request**.
2. Click **Confirm merge**.
3. Once your branch has been merged, you don't need it anymore. To delete this branch, click **Delete branch**.

![screenshot showing delete branch button](../../images/delete-branch.png)
![screenshot showing delete branch button](/images/delete-branch.png)

4. 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.

Expand Down

0 comments on commit 86a4bea

Please sign in to comment.