|
| 1 | +# 🧩 1.0 Orientation |
| 2 | + |
| 3 | +% ```{rubric} 🧩 1.0 Orientation |
| 4 | +% ``` |
| 5 | + |
| 6 | +```{contents} |
| 7 | +:depth: 3 |
| 8 | +``` |
| 9 | + |
| 10 | +## 🔰 Getting Started |
| 11 | + |
| 12 | +First, open up the following quiz in Canvas that corresponds to your enrolled term. |
| 13 | + |
| 14 | +::::{tab-set} |
| 15 | +:sync-group: category |
| 16 | + |
| 17 | +:::{tab-item} W 2024 |
| 18 | +:sync: w2024 |
| 19 | + |
| 20 | +[TBD] |
| 21 | +::: |
| 22 | + |
| 23 | +:::{tab-item} Sp/Su 2024 |
| 24 | +:sync: sp2024 |
| 25 | + |
| 26 | +[TBD] |
| 27 | +::: |
| 28 | + |
| 29 | +:::: |
| 30 | + |
| 31 | +You will record your GitHub username and GitHub Classroom Student Identifier, which will be used later in the course. You can refer back to these quiz answers if you forget. See below for information on these two. |
| 32 | + |
| 33 | +### GitHub Account |
| 34 | + |
| 35 | +These courses are integrated with coding exercises via GitHub Classroom, so you will need to [create a GitHub account](https://github.com/join) if you don't already have one. Take note of your GitHub username since you will enter this as a quiz response. |
| 36 | + |
| 37 | +```{tip} |
| 38 | +Two typical naming conventions for GitHub usernames are as follows: |
| 39 | +- John H. Smith → `jhsmith` |
| 40 | +- Jane M. Doe → `jane-doe` |
| 41 | +
|
| 42 | +If you already have a GitHub account and you have used it infrequently, you may consider [renaming your GitHub account](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/changing-your-github-username) to adhere to one of the conventions above. This is completely optional. |
| 43 | +``` |
| 44 | + |
| 45 | +### GitHub Starter Tutorial |
| 46 | + |
| 47 | +```{warning} |
| 48 | +The student identifier that you choose on the next page **will appear only once** (e.g., `quirky-zebra`). Please record this somewhere safe and enter it into the corresponding Canvas quiz, since you will be using this at various points throughout the course. If you forget or lose your student identifier, please send a message to [[email protected]](mailto:[email protected]). |
| 49 | +``` |
| 50 | + |
| 51 | +Click on the 🔗 [GitHub starter tutorial](https://classroom.github.com/a/g78UiC5K), ensure you're logged in to GitHub, link to a student identifier of your choice (write this down), and accept the assignment. See below for a walkthrough of this. |
| 52 | + |
| 53 | +<video width="700" height="394" controls> |
| 54 | + <source src="../../_static/intro-gh-classroom-walkthrough.mp4" type="video/mp4"> |
| 55 | + Your browser does not support the video tag. |
| 56 | +</video> |
| 57 | + |
| 58 | +<!-- <iframe style="width: 700px; height: 394px; display: inline-block;" title="Video player for github-starter-tutorial-select-accept.mp4" data-media-type="video" src="/media_attachments_iframe/31726637?embedded=true&type=video" allowfullscreen="allowfullscreen" allow="fullscreen" data-media-id="m-49uHHDJPuMSZGb2RheoEbnm8NtVvuFMV" data-mce-fragment="1"></iframe> --> |
| 59 | + |
| 60 | +```{margin} |
| 61 | +There is a pre-populated list of student identifiers, none of which have been claimed! You may choose any of these. |
| 62 | +``` |
| 63 | + |
| 64 | +Use this tutorial to familiarize yourself with git and GitHub terminology, which you will be quizzed on later. |
| 65 | + |
| 66 | +## 📄 GitHub Classroom Assignment |
| 67 | + |
| 68 | +Now that you're familiar with basic git and GitHub terminology, now we can show you how to use GitHub Classroom for an autograded assignment. |
| 69 | + |
| 70 | +👉 **Second step**: This time, you will use an interactive development environment (IDE) called "Codespaces", with compute resources provided by the Acceleration Consortium through the GitHub Education program. Similar to the format before, click on the new assignment link 🔗 [Intro to GitHub Classroom](https://classroom.github.com/a/3yCVzX6I), ensure you're logged in to GitHub, accept the assignment, click the "Open in Codespaces" button, and follow the directions in the README.md file. Spinning up a new Codespace may take a minute or two, and a preview of the README.md file will automatically open up after a few seconds. A number of dialogue boxes and messages will appear during the loading process. Ensure that you sign into GitHub; use of Copilot is optional. The URL in your browser should be of the form `https://<some-funny-phrase>-<unique-id>.github.dev/` which is autogenerated and distinct from your course ID. For example, your URL might be `https://fuzzy-space-spork-9wggxx444g6h7rxq.github.dev/`. You can try the assignment as many times as you like, and you will self-report your autograded score on the next page. See below for a complete walkthrough of these steps. |
| 71 | + |
| 72 | +<video width="700" height="394" controls> |
| 73 | + <source src="../../_static/run-the-demo-walkthrough.mp4" type="video/mp4"> |
| 74 | + Your browser does not support the video tag. |
| 75 | +</video> |
| 76 | + |
| 77 | +<!-- <iframe style="width: 700px; height: 394px; display: inline-block;" title="autograding-codespaces-python-walkthrough.mp4" data-media-type="video" src="https://q.utoronto.ca/media_attachments_iframe/31726639?embedded=true&type=video" allowfullscreen="allowfullscreen" allow="fullscreen" data-titletext="autograding-codespaces-python-walkthrough.mp4" data-media-id="m-4qfTw9UDxLo8XrZpxMwCLDoT16FfTikf"></iframe> --> |
| 78 | + |
| 79 | +Additional resources: |
| 80 | + |
| 81 | +- [How students complete assignments](https://youtu.be/ObaFRGp_Eko?si=JMxjdheVKVc3Zwr8) |
| 82 | +- [What is Codespaces?](https://youtu.be/sYJ3CHtT6WM) |
| 83 | +- [Student developer pack](https://education.github.com/pack) |
| 84 | + |
| 85 | +```{tip} |
| 86 | +If you're eligible, consider signing up for the [student developer pack](https://education.github.com/pack) so that **you can have free access to GitHub Copilot (and GitHub Copilot Chat)**, among other perks. **GitHub Copilot is also free for teachers**. |
| 87 | +
|
| 88 | +If you're not eligible, you may consider a paid subscription (~$10 USD/month). It's kind of like having a personal coding assistant to bounce ideas off of and have it look at your code. At the same time, it can become a crutch, and there are still times where plain-old Google searches, reading stack overflow posts, and searching through a GitHub repository's issues and documentation is better. The Acceleration Consortium does not benefit from you signing up for GitHub Copilot, and it is not required for the completion of this course. |
| 89 | +``` |
| 90 | + |
| 91 | +## 📄 Python Refresher Assignment |
| 92 | + |
| 93 | +Optionally, you may try out the [Python refresher assignment](https://classroom.github.com/a/oDMoonRK). This is ungraded. |
0 commit comments