Assignment

.github/issue_template.yaml

@@ -0,0 +1,46 @@
+name: Bug Report
+description: Report a bug
+title: "[Bug]: "
+labels: ["bug"]
+assignees:
+  - danielrazavi
+  - rohanalexander
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please fill out the sections below to help everyone identify and fix the bug
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe your issue
+      placeholder: When I click here this happens
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      placeholder: |
+        1. Go to page X
+        2. Click here
+        3. Click there
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: What was the expected result?
+      placeholder: I expected this to happen
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Put here any screenshots or videos (optional)
+  - type: textarea
+    id: assignee
+    attributes:
+      label: Put here the code owner you'd like to review this issue.
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for reporting this issue! We will get back to you as soon as possible.

.github/pull_request_template.md

@@ -0,0 +1,14 @@
+## What changes are you trying to make? (e.g. Adding or removing code, refactoring existing code, adding reports)
+
+## What did you learn from the changes you have made?
+
+## Was there another approach you were thinking about making? If so, what approach(es) were you thinking of?
+
+## Were there any challenges? If so, what issue(s) did you face? How did you overcome it?
+
+## How were these changes tested?
+
+## A reference to a related issue in your repository (if applicable)
+
+## Checklist
+- [ ] I can confirm that my changes are working as intended

.github/workflows/autograder.yml

@@ -0,0 +1,42 @@
+name: Assignment autograder
+on: 
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened]
+jobs:
+  autograder:
+    name: Assignment autograder
+    if: startsWith(github.head_ref, 'assignment')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r 03_instructional_team/autograder/requirements.txt
+      - name: Setup working directory for script
+        run: |
+          UUID=$(uuidgen)
+          echo "UUID=$UUID" >> $GITHUB_ENV
+          mkdir /tmp/$UUID
+          cp $GITHUB_WORKSPACE/02_activities/assignments/assignment.sh /tmp/$UUID
+      - name: Run assignment script
+        run: |
+          bash -c "bash assignment.sh 2>&1 | tee /tmp/${{ env.UUID }}_output.txt"
+        working-directory: /tmp/${{ env.UUID }}
+      - name: Grade responses
+        id: grade
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REPO_OWNER: ${{ github.repository_owner }}
+          REPO_NAME: ${{ github.event.repository.name }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+          REPO_BRANCH: ${{ github.event.pull_request.head.ref }}
+          WORKING_DIR: /tmp/${{ env.UUID }}
+        run: |
+          wget -O /tmp/autograder.py https://github.com/UofT-DSI/shell/raw/refs/heads/main/03_instructional_team/autograder/autograder.py
+          python /tmp/autograder.py

.github/workflows/automatic_pr_comment.yaml

@@ -0,0 +1,25 @@
+name: UofT-DSI Main Repository PR Workflow
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+
+jobs:
+  comment:
+    if: github.repository_owner == 'UofT-DSI'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment on PR
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const issue_number = context.payload.pull_request.number;
+            const repo = context.repo;
+            const commentBody = `Hello, thank you for your contribution. If you are a participant, please close this pull request and open it in your own forked repository instead of here. Please read the instructions on your onboarding [Assignment Submission Guide](https://github.com/UofT-DSI/onboarding/blob/main/onboarding_documents/submissions.md) more carefully. If you are not a participant, please give us up to 72 hours to review your PR. Alternatively, you can reach out to us directly to expedite the review process.`;
+            // Check if the PR is made to a repo in the UofT-DSI organization
+            github.rest.issues.createComment({
+              owner: repo.owner,
+              repo: repo.repo,
+              issue_number: issue_number,
+              body: commentBody
+            });

.gitignore

@@ -1 +1,18 @@
 .DS_Store
+.vscode/
+03_instructional_team/lessons/pdf/*
+03_instructional_team/lessons/html/*
+
+# local node modules
+node_modules/
+package-lock.json
+package.json
+
+### Running the assignment script unzips a large number of files into the tree
+# Ignore all files in shell/02_activities/assignments/
+02_activities/assignments/*
+
+# Un-ignore the specific files
+!02_activities/assignments/assignment.sh
+!02_activities/assignments/assignment_instructions.md
+

02_activities/assignments/assignment.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+set -x
+
+############################################
+# DSI CONSULTING INC. Project setup script #
+############################################
+# This script creates standard analysis and output directories
+# for a new project. It also creates a README file with the
+# project name and a brief description of the project.
+# Then it unzips the raw data provided by the client.
+
+mkdir analysis output
+touch README.md
+echo "# Project Name: DSI Consulting Inc." > README.md
+touch analysis/main.py
+
+# download client data
+curl -Lo rawdata.zip https://github.com/UofT-DSI/shell/raw/refs/heads/main/02_activities/assignments/rawdata.zip
+unzip rawdata.zip
+
+###########################################
+# Complete assignment here
+
+# 1. Create a directory named data
+mkdir data
+# 2. Move the ./rawdata directory to ./data/raw
+mv ./rawdata ./data/raw
+# 3. List the contents of the ./data/raw directory
+ls ./data/raw
+# 4. In ./data/processed, create the following directories: server_logs, user_logs, and event_logs
+mkdir ./data/processed
+mkdir ./data/processed/server_logs ./data/processed/user_logs ./data/processed/event_logs
+# 5. Copy all server log files (files with "server" in the name AND a .log extension) from ./data/raw to ./data/processed/server_logs
+cp ./data/raw/*server*.log ./data/processed/server_logs
+# 6. Repeat the above step for user logs and event logs
+cp ./data/raw/*user*.log ./data/processed/user_logs
+cp ./data/raw/*event*.log ./data/processed/event_logs
+# 7. For user privacy, remove all files containing IP addresses (files with "ipaddr" in the filename) from ./data/raw and ./data/processed/user_logs
+rm -rf ./data/raw/*ipaddr*
+rm -rf ./data/processed/user_logs/*ipaddr*
+# 8. Create a file named ./data/inventory.txt that lists all the files in the subfolders of ./data/processed
+touch ls -r ./data/processed/*/* >> ./data/inventory.txt
+
+
+###########################################
+
+echo "Project setup is complete!"

02_activities/assignments/assignment_instructions.md

@@ -0,0 +1,93 @@
+# Shell / Git Assignment
+You work in the data team at a consulting firm, and one of your team's products is helping companies optimize and manage their cloud hosting expenditures.
+
+Your team has an existing bash script that initializes an analysis directory for each new client.
+
+You've been asked to update this script to also automate the initial organization of data files provided by clients.
+
+## Instructions
+
+### Setup
+1. **Forking the Repository**: If you have not already done so, fork this Shell learning module repository following these [instructions](https://github.com/UofT-DSI/onboarding/blob/main/onboarding_documents/submissions.md#setting-up). 
+   - Forking creates a copy of the main repository in your GitHub account. This allows you to work on your version without affecting the original repository.
+2. **Create a Branch for Your Work**: To keep your changes organized, create a new branch named `assignment`:
+   ```bash
+   git checkout -b assignment
+   ```
+
+---
+
+### Part 1: Update the Data Ingest Script
+1. **Modify the Script**: Using the template in ``02_activities/assignments/assignment.sh``, fill in the correct commands as described by the comments.
+    - It may help to paste your commands into the Terminal as you write your script (or vice versa) to test as you go
+2. **Test Your Script Locally**: Execute your script to ensure it works as expected. You may need to make additional tweaks and re-run it until you are satisfied with the results.
+3. **Commit Your Changes**: As you complete parts of your script and confirmed that it is working correctly, commit your changes to ensure your progress is saved.
+    ```bash
+    git commit assignment.sh -m "describe your changes here"
+    ```
+
+---
+
+### Part 2: Merge in Updates from Your Coworkers
+Your coworkers have made some other changes to the script. You'll need to incorporate their updates and resolve any conflicts.
+1. **Merge the Updates**: Use the following command to pull in changes from the coworker's branch:
+   ```bash
+   git pull https://github.com/UofT-DSI/shell coworker-changes --no-rebase
+   ```
+2. **Resolve Merge Conflicts**: If there are any conflicts, use ```git status``` to see which files are affected, resolve the conflicts manually, and then mark them as resolved.
+3. **Commit the Merge**: Once all conflicts are resolved, commit the merge.
+
+---
+
+### Part 3: Test Your Script
+1. **Re-test Your Script**: Make sure that your script still works after merging the updates.
+2. **Optional Clean Test Setup**: If you'd like to test your script in a clean environment, follow these steps:
+   ```bash
+   mkdir assignment_test_clean    # make an empty directory
+   ```
+   ```bash
+   cp assignment.sh assignment_test_clean    # copy your script into the empty directory
+   ```
+   ```bash
+   cd assignment_test_clean    # change your working directory to the new clean directory
+   ```
+3. **Run Your Script**:
+   ```bash
+   bash assignment.sh
+   ```
+4. **Verify the Output**:
+   - Check if the expected directories are created.
+   - Verify that files are moved or copied as expected.
+   - Ensure that files that should be deleted are no longer present.
+
+---
+
+### Submit Your Changes for Review
+1. **Commit Your Final Changes**: Ensure all changes are committed in your `assignment` branch. You can verify this with:
+   ```bash
+   git status
+   ```
+2. **Enable GitHub Actions**: Click on the **Actions** tab in your repository and enable workflows if prompted.
+3. **Create a Pull Request**:
+   - Open a pull request from your `assignment` branch to your repository's `main` branch.
+   - The autograder will run automatically and post your assignment grade as a comment.
+
+---
+
+## Submission Information
+
+🚨 **Please review our [Assignment Submission Guide](https://github.com/UofT-DSI/onboarding/blob/main/onboarding_documents/submissions.md)** 🚨 for detailed instructions on how to format, branch, and submit your work. Following these guidelines is crucial for your submissions to be evaluated correctly.
+
+### Submission Parameters:
+* Submission Due Date: `2025-01-15 - 23:59`
+* The branch name for your repo should be: `assignment`
+* What to submit for this assignment:
+    * One or more commits that update the `assignment.sh` script
+* What the pull request link should look like for this assignment: `https://github.com/<your_github_username>/shell/pull/<pr_id>`
+    * Open a private window in your browser. Copy and paste the link to your pull request into the address bar. Make sure you can see your pull request properly. This helps the technical facilitator and learning support staff review your submission easily.
+
+Checklist:
+- [ ] Create a branch called `assignment`.
+- [ ] Ensure that your repository is public.
+- [ ] Review [the PR description guidelines](https://github.com/UofT-DSI/onboarding/blob/main/onboarding_documents/submissions.md#guidelines-for-pull-request-descriptions) and adhere to them.
+- [ ] Verify that your link is accessible in a private browser window.

02_activities/homework/homework.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# On your terminal, input all the commands you have used to create the following:
+
+# 1. How would you create 5 directories? Feel free to use any name for your directories.
+
+# 2. How would you verify the creation of all 5 directories?
+
+# 3. In each directory, how would you create 5 .txt files and write "I love data" into each within the directories?
+
+# 4. How would you verify the presence of all 5 files?
+
+# 5. How would you append to one of the existing files " and machine learning!"?
+
+# 6. How would you verify that the text was indeed appended to the existing file?
+
+# 7. How would you delete all files except for the one with the appended text?
+
+# 8. How would you navigate back to the parent directory containing all the directories?
+
+# 9. How would you remove each directory along with its contents?
+
+# 10. How would you verify that all directories and files have been deleted?

03_instructional_team/README.md

@@ -0,0 +1,54 @@
+# Instructional Team Playbook
+
+## How do you interact with the repo?
+The Technical Facilitator will deliver the content in the `/01_materials/slides` directory. You are encouraged to live code with participants during live sessions. Please ensure that live coding files are uploaded to a new directory called `/live_code` under `/04_cohort_three` in this repository using a new branch. Please open a pull request for it to be merged.
+
+## How does the module flow?
+The module is organized into 3 main directories:
+1. Slides
+2. Assignments
+3. Homework
+
+The `/01_materials/slides` directory contains the live learning session slides.
+
+The `/02_activities/assignments` contains assignments participants should submit for evaluation as  `complete` or `incomplete`. The assignments measure a participant's achievement of the learning outcomes, and help technical facilitators determine if a participant has successfully completed the learning module. 
+
+The `/02_activities/homework` directory contains homework participants can complete to further develop and practice the skills covered in a learning module. Homework is optional, but participants are encouraged to complete as much as they can. 
+
+### Week 1
+
+#### Live Learning Session
+The focus of the live learning session is to introduce participants to basic bash commands such as `cd` and `pwd`, as well as creating files using `touch` and directories using `mkdir`. The module also introduces intermediate commands like `rm`, how to recursively remove files from a nested directory, and how to make copies or move files using `mv`.
+
+Note: If someone wants to open up the "manual", recommend they use the `man` command.
+
+#### Assignment
+The assignment for this week is to have participants find the secret password by navigating directories and files.
+
+## How do you assign assignments?
+Technical Facilitators are encouraged to introduce assignments as early as possible in the learning module. The Technical Facilitator should describe the assignment to participants and explain how the topics covered in the module will equip them with the knowledge and skills to complete the assignment. 
+
+## How is an assignment is expected to be completed and delivered?
+Participants are expected to complete the assignment by the end of the first week. They will deliver the assignment by opening a pull request on their copied repo. The participants will also add a Learning Support Staff as a reviewer indicating they delivered a completed assignment, and it is ready to be evaluated as `complete` or `incomplete`.
+
+## What is the criteria for `complete` or `incomplete`?
+The criteria for a `complete` or `incomplete` is if all parts of the program are working, and nothing in the code is broken. For some assignments, a rubric is provided outlining the criteria needed to assess an assignment as incomplete.
+
+## How to evaluate?
+If the participant's solution works, then their assignment should be assessed as `complete`! Technical Facilitators and the Learning Support Staff should focus on providing constructive feedback to participants who need to improve their code. If the solution does not work, then the assignment is `incomplete`. Facilitators should provide constructive feedback on their existing code, and guide them to get their solution working.
+
+## How will feedback be given?
+Feedback should be given through the pull request a participant has made. Technical Facilitators are encouraged to allow participants to make revisions if needed. In order to maximize learning, feedback should be constructive, and specific.
+
+<hr>
+
+## Definitions
+**Live Learning Sessions**: A Live Learning Session is a synchronous period of time, lasting up to 2.5 hours, where the Technical Facilitator will facilitate and deliver the content and learning outcomes online through Zoom. Participants are encouraged to participate and ask questions as they learn. 10 minute breaks are encouraged once per hour.
+
+**Work Period**: A Work Period is an asynchronous period of time, lasting up to 3 hours. Participants will work on assignments and/or homework during this block of time. Learning Support Staff are to be present online through Zoom to assist participants and answer any questions they may have. As work periods are asynchronous and flexible, participants can choose to work on their own time. However, it is encouraged that they work during the block of time when a Learning Support Staff is present.
+
+**Assignments**: An Assignment is work assigned as part of the learning modules. They provide an opportunity for participants to integrate and synthesize what they have learned throughout the week to meet the set learning outcomes.
+
+## generate_slides.sh
+
+This script is designed to convert Markdown files located in a specified folder into slide presentations using Marp CLI, allowing for the generation of either HTML or PDF formats based on user input. It includes an option to apply a custom CSS theme to the slides by specifying a theme path. The script also provides a help function detailing its usage, options, and examples for convenience. It ensures the necessary directories exist, validates the presence of Marp CLI on the system, processes each Markdown file found in the specified directory, and outputs the generated slides into a designated output folder, displaying the status of each operation and a completion message. The only configuration needed is to set where the md files are and where you would like the pdf/html files to be placed.