differences for PR #31

esciencecenter-digital-skills · Sep 23, 2024 · 39a14d9 · 39a14d9
1 parent 47314fd
commit 39a14d9
Show file tree

Hide file tree

Showing 19 changed files with 93 additions and 29 deletions.
diff --git a/fig/git-checkout.svg b/fig/git-checkout.svg
diff --git a/fig/git-committing.svg b/fig/git-committing.svg
diff --git a/fig/git-freshly-made-github-repo.svg b/fig/git-freshly-made-github-repo.svg
diff --git a/fig/git-restore.svg b/fig/git-restore.svg
diff --git a/fig/git-staging-area.svg b/fig/git-staging-area.svg
diff --git a/fig/git_staging.svg b/fig/git_staging.svg
diff --git a/fig/github-change-repo-string.png b/fig/github-change-repo-string.png
diff --git a/fig/github-create-repo-01.png b/fig/github-create-repo-01.png
diff --git a/fig/github-create-repo-02.png b/fig/github-create-repo-02.png
diff --git a/fig/github-create-repo-03.png b/fig/github-create-repo-03.png
diff --git a/fig/github-find-repo-string.png b/fig/github-find-repo-string.png
diff --git a/fig/github-repo-after-first-push.svg b/fig/github-repo-after-first-push.svg
diff --git a/fig/merge.svg b/fig/merge.svg
diff --git a/fig/motivatingexample.png b/fig/motivatingexample.png
diff --git a/fig/phd101212s.png b/fig/phd101212s.png
diff --git a/fig/play-changes.svg b/fig/play-changes.svg
diff --git a/fig/versions.svg b/fig/versions.svg
diff --git a/md5sum.txt b/md5sum.txt
@@ -15,6 +15,6 @@
 "episodes/09-collab-distributed.md" "82b38860c7b6a932a19f3be96b7d9265" "site/built/09-collab-distributed.md" "2024-06-26"
 "instructors/instructor-notes.md" "cae72b6712578d74a49fea7513099f8c" "site/built/instructor-notes.md" "2024-03-27"
 "learners/reference.md" "1c7cc4e229304d9806a13f69ca1b8ba4" "site/built/reference.md" "2024-03-27"
-"learners/setup.md" "5456593e4a75491955ac4a252c05fbc9" "site/built/setup.md" "2024-03-27"
+"learners/setup.md" "72adb5e2664187f5e39d30c17c85a50e" "site/built/setup.md" "2024-09-23"
 "profiles/learner-profiles.md" "60b93493cf1da06dfd63255d73854461" "site/built/learner-profiles.md" "2024-03-27"
 "renv/profiles/lesson-requirements/renv.lock" "1b31c11be0d38181a0a48f9068fa1a09" "site/built/renv.lock" "2024-07-02"
diff --git a/setup.md b/setup.md
@@ -2,53 +2,117 @@
 title: Setup
 ---
 
-FIXME: Setup instructions live in this document. Please specify the tools and
-the data sets the Learner needs to have installed.
+::::::::::::::::::::::::::::::prereq
 
-## Data Sets
+In this lesson we use Git from the Unix Shell. Some previous experience with the shell is expected, but isn’t mandatory.
 
-<!--
-FIXME: place any data you want learners to use in `episodes/data` and then use
-       a relative link ( [data zip file](data/lesson-data.zip) ) to provide a
-       link to it, replacing the example.com link.
--->
-Download the [data zip file](https://example.com/FIXME) and unzip it to your Desktop
+::::::::::::::::::::::::::::::
+
+## Computer
+
+Participants must work on a computer with a Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) on which they have administrative privileges.
 
 ## Software Setup
 
-::::::::::::::::::::::::::::::::::::::: discussion
+To participate in this workshop, you will need to prepare the following (if you haven't already):
 
-### Details
+#### Install Shell and Git. 
+
+:::tab
 
-Setup for different systems can be presented in dropdown menus via a `spoiler`
-tag. They will join to this discussion block, so you can give a general overview
-of the software used in this lesson here and fill out the individual operating
-systems (and potentially add more, e.g. online setup) in the solutions blocks.
+### Windows
+Git should be installed on your computer as part of your Bash install.
 
-:::::::::::::::::::::::::::::::::::::::::::::::::::
 
-:::::::::::::::: spoiler
+### Mac  
+Mac
 
-### Windows
+### Linux
+If Git is not already available on your machine you can install it via your distro's package manager. Debian/Ubuntu run 'sudo apt-get install git' and for Fedora run 'sudo dnf install git'.
 
-Use PuTTY
+:::
+
+#### Setup GitHub 
 
-::::::::::::::::::::::::
+You will need an account for [GitHub](https://github.com/) to follow episodes 7, 8, 9 in this lesson.
 
-:::::::::::::::: spoiler
+1. To sign up for an account, navigate to https://github.com/ and follow the prompts.
+2. Verify your email address.
+3. Configure GitHub authentication.
 
-### MacOS
+You must authenticate before you can access certain resources on GitHub.
+Each way of accessing GitHub supports different authentication method. For example, you can authenticate with GitHub via browser using two-factor authentication (2FA), or you can authenticate with GitHub via the command line using Secure Shell Protocol (SSH). In our lesson we shall use both.
 
-Use Terminal.app
+:::tab
 
-::::::::::::::::::::::::
+### 2FA 
 
+To set up 2FA for your GitHub account, follow these steps:
 
-:::::::::::::::: spoiler
+1. If you already use an authenticator app, like [Google Authenticator](https://support.google.com/accounts/answer/1066447?hl=en&co=GENIE.Platform%3DiOS&oco=0) on your smartphone for example, add GitHub to that app.
+2. If you have access to a smartphone but do not already use an authenticator app, install one and add GitHub to the app.
+3. Optionally, you can add a passkey to your account. Passkeys are similar to security keys. However, passkeys satisfy both password and 2FA requirements, so you can sign in to your account in one step.
 
-### Linux
+### SSH   
+
+To set up SSH for your GitHub account, follow these steps:
+
+1. Generate an SSH public/private keypair on your local machine if you don't already have one.
+
+To check your local machine for existing SSH keys, run the following command in the terminal:
+
+```bash
+    ls -al ~/.ssh
+```
+
+Then check the directory listing to see if you already have a public SSH key. By default, the filenames of supported public keys for GitHub are one of the following.
+
+```bash
+    id_rsa.pub
+    id_ecdsa.pub
+    id_ed25519.pub
+```
+
+If you receive an error that ~/.ssh does not exist, you do not have an existing SSH key pair in the default location. You can create a new SSH key pair in the next step.
+
+2. Either generate a new SSH key or upload an existing key.
+
+- If you don't have a supported public and private key pair, or don't wish to use any that are available, generate a new SSH key.
+- 
+
+:::
+
+Refer to the GitHub [documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-authentication-to-github) for more details about authentication.
+
+
+#### Confirm that everything works
+
+You should now be able to open a terminal window and execute the following commands:
+
+#### Git
+
+```bash
+$ git --version
+```
+which will return (something similar to):
+
+```bash
+git version 2.34.1
+```
+
+#### Github accreturningount & SSH connection
+
+```bash
+ssh [email protected]
+```
+
+which will return:
 
-Use Terminal
+```bashreturning
+Hi [username]! You've successfully authenticated, but GitHub does not provide shell access.
+Connection to github.com closed.
+```
 
-::::::::::::::::::::::::
+### If something does not work
 
+Follow the corresponding setup instructions. If you still need help, send us an [email]([email protected]).