Skip to content

Commit 29cd7e0

Browse files
committed
finalize instructions for lab 0
1 parent 3875b21 commit 29cd7e0

3 files changed

Lines changed: 39 additions & 31 deletions

File tree

src/lab_0/assets/deployments.png

387 KB
Loading

src/lab_0/assets/pages.png

300 KB
Loading

src/lab_0/index.md

Lines changed: 39 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,7 @@ The goals for this tutorial are:
1010
The assignment requirements are as follows:
1111
1. Replicate the local environment created in class on your own computer ([Installations](#installations))
1212
2. Fork this repository, set up github pages, and initialize your upstream repository ([Github Setup](#github-setup))
13-
14-
To submit your assignment, TODO
15-
16-
13+
3. Submit your [deployed link](#4-set-up-your-github-pages-for-your-deployment) as a comment on the lab 0 commons post.
1714

1815
# Installations
1916

@@ -34,7 +31,7 @@ The first step is to install all the appropriate software to get our environment
3431

3532
You can read more about `forking`, `syncing`, and the overall github flow [here](https://help.github.com/en/github/getting-started-with-github/fork-a-repo).
3633

37-
### 1. On Gitub, within to our [main repository](https://github.com/InteractiveDataVis/Interactive-Data-Vis-Fall2025.git) and [`fork`](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) this repository into your own account.
34+
## 1. On Gitub, within to our [main repository](https://github.com/InteractiveDataVis/Interactive-Data-Vis-Fall2025.git) and [`fork`](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) this repository into your own account.
3835

3936
To do this, click on the "fork" button on the top right of this github account.
4037

@@ -46,15 +43,7 @@ This creates a clone of our class repository in your own github account. After t
4643

4744
This repository is _your_ personal copy of the existing repository. This will be where you do all your lab work, and will include the deployed links that you will submit when turning in your assignments.
4845

49-
### 2. Set up your Github Pages for your deployment
50-
51-
We use [Github Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/what-is-github-pages) to serve our websites publicly. Github Pages is static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub, optionally runs the files through a build process, and publishes a website.
52-
53-
<!-- To [set up your github pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site), you can go to your repository's `Settings` tab and then scroll down to `Pages` section. Select `Github Actions` as source ("Deploy from a branch") and then your site will be avallable at `https://[YOUR_USERNAME].github.io/[YOUR_REPOSITORY_NAME]/`. *NOTE*: You must navidate in the URL to a folder with an index.html, or else you will get a 404. This will take a few minutes to update with any pushed changes. -->
54-
55-
<!-- <img src='../lib/assets/pages.png' width='500px'> -->
56-
57-
### 3. On GitHub, navigate to **your fork** of the repository and clone it to your local computer.
46+
## 2. On GitHub, navigate to **your fork** of the repository and clone it to your local computer.
5847

5948
To do this, navigate to the folder where you want to save your files (I like to save mine in `Documents/Repositories`). (Hint: `cd` or 'change directory' will help you get there through terminal).
6049

@@ -71,7 +60,7 @@ $ git clone https://github.com/[YOUR_USERNAME]/Interactive-Data-Vis-Fall2025
7160
$ cd Interactive-Data-Vis-Fall2025
7261
```
7362

74-
### 4. Set up your local repository so that it links back to the course repository.
63+
## 3. Set up your local repository so that it links back to the course repository.
7564

7665
We do this so that you can keep your local branch synced up with the main course repository when we update the material. With this set up, you can simply `pull` in the new changes from our original class repository.
7766

@@ -103,23 +92,24 @@ $ git remote -v
10392
# now notice see that we are tracking both the original and your version of the repository
10493
```
10594

106-
### 6. Keep your repository [synced](https://help.github.com/en/github/getting-started-with-github/fork-a-repo#keep-your-fork-synced).
10795

108-
Make sure to do this before working on new code (before each tutorial) to ensure that you are working off of the latest updates. We may update the course repository at some point in the semester, and this command will update your fork to include the changes we made, including that week's class example or other materials we have added.
96+
## 4. Set up your Github Pages for your deployment
10997

110-
```sh
111-
# pulls the upstream changes and stores them in `upstream/main`
112-
$ git fetch upstream
113-
```
98+
We use [Github Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/what-is-github-pages) to serve our websites publicly. Github Pages is static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub, optionally runs the files through a build process, and publishes a website.
11499

115-
```sh
116-
# merges the changes from upstream into your current branch
117-
$ git merge upstream/main
118-
```
100+
To [set up your github pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site), you can go to your repository's `Settings` tab and then scroll down to `Pages` section. Select `Github Actions` as source ("Deploy from a branch").
101+
102+
<img src='assets/pages.png' width='700px'>
119103

120-
(You can read more information about this [here](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork))
104+
The workflow code is already included in the main class repository. When you push your changes up to github, then your site will automatically be redeployed and be avallable at `https://[YOUR_USERNAME].github.io/[YOUR_REPOSITORY_NAME]/`.
121105

122-
### 7. Push up and deploy your changes
106+
You can see all the deployments triggered from pushed in the deployments section of your repository page.
107+
108+
<img src='assets/deployments.png' width='700px'>
109+
110+
*NOTE*: You must navidate in the URL to a folder with an index.html, or else you will get a 404. This will take a few minutes to update with any pushed changes.
111+
112+
### 5. Push up and deploy your changes
123113

124114
[Note: VS Code has some great [tools](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support) built in to help with this process.]
125115

@@ -161,9 +151,26 @@ More resources to understand these interfaces:
161151
* PC: [Command Prompt Basics (youtube tutorial)](https://www.youtube.com/watch?v=QBWX_4ho8D4)
162152
* [Complete List: Command Line Prompt (CMD)](https://www.codecademy.com/article/command-line-commands)
163153

164-
## Helpful terminal commands for navigation
165154

166-
### Windows Command Prompt (CMD)
155+
### Keeping your repository synced
156+
157+
As the semester progresses, updates may be pushed to the class repository. The following terminal commands can keep your repo [synced](https://help.github.com/en/github/getting-started-with-github/fork-a-repo#keep-your-fork-synced). Make sure to do this before working on new code to ensure that you are working off of the latest updates.
158+
159+
```sh
160+
# pulls the upstream changes and stores them in `upstream/main`
161+
$ git fetch upstream
162+
```
163+
164+
```sh
165+
# merges the changes from upstream into your current branch
166+
$ git merge upstream/main
167+
```
168+
169+
(You can read more information about this process [here](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork))
170+
171+
### Helpful terminal commands for navigation
172+
173+
**Windows Command Prompt (CMD)**
167174

168175
- `dir`: List files and folders in current directory
169176
- `cd [folder]`: Change directory (e.g., cd Documents)
@@ -175,7 +182,7 @@ More resources to understand these interfaces:
175182
- `copy [source] [destination]`: Copy files
176183
- `move [source] [destination]`: Move/rename files
177184

178-
### macOS/Linux Terminal
185+
**macOS/Linux Terminal**
179186

180187
- `ls`: List files and folders (ls -la for detailed view)
181188
- `cd [folder]`: Change directory
@@ -186,4 +193,5 @@ More resources to understand these interfaces:
186193
- `rmdir [name]`: Remove empty folder
187194
- `rm [filename]`: Delete file (rm -r [folder] for folders)
188195
- `cp [source] [destination]`: Copy files
189-
- `mv [source] [destination]`: Move/rename files
196+
- `mv [source] [destination]`: Move/rename files
197+

0 commit comments

Comments
 (0)