Documentation

Complete guide to the Regis University Data Science Practicum Portfolio System

System Overview

This system provides a centralized platform for showcasing Regis University Data Science students' practicum projects (MSDS 692/696) across multiple semesters. It features automated portfolio generation through CSV-based workflows and maintains historical data while highlighting exceptional work.

🎓 For Students

  • • Create professional portfolios using markdown files
  • • Showcase MSDS 692 and 696 practicum projects
  • • Upload reports, presentations, and project files
  • • Professional HTML portfolios generated automatically

👩‍🏫 For Instructors

  • • Upload CSV files to create student environments
  • • Automated system handles portfolio generation
  • • Manage spotlight projects to highlight exceptional work
  • • One-click deployment to live website

CSV-Based Automation Workflow

🚀 Automated Portfolio Generation

The system uses CSV files and automated workflows to create professional portfolios for all students in a course. Instructors upload a single CSV file, and the system handles the rest.

1. Upload CSV

Create and upload student roster CSV file

2. Run Automation

Automated system creates student folders

3. Deploy

Generate and deploy portfolios

Example CSV Format:

Student Name,Email,Username,Project_Title,GitHub_Profile,Practicum_1_GitHub,LinkedIn_Profile,Portfolio_Page
"John Doe","jdoe@regis.edu","jdoe001","ML Trading Bot","https://github.com/jdoe001","","",""
"Jane Smith","jsmith@regis.edu","jsmith002","Data Analytics Platform","https://github.com/jsmith002","","",""

Naming convention: YYYY_Semester_CourseCode.csv

Automation System

Setup Student Environment

Trigger: CSV file upload to data/ folder

  • • Creates student folders and templates
  • • Generates JSON data files
  • • Sets up file organization structure

Deploy Portfolios

Trigger: Manual execution

  • • Converts markdown to HTML
  • • Applies Regis University branding
  • • Deploys to live website

Student Guide

Quick Start Process

  1. 1. Access your assigned student folder in regis_std repository
  2. 2. Edit the profile.md file with your information
  3. 3. Upload your avatar, CV, reports, and presentations
  4. 4. Portfolio is generated automatically

File Organization

  • • profile.md - Your main profile content
  • • avatar.jpg - Profile photo
  • • presentations/ - Practicum slides
  • • reports/ - Practicum reports
View Complete Student Guide

Instructor Guide

Semester Setup

  1. 1. Create CSV file with student roster
  2. 2. Upload to regis_std repository data/ folder
  3. 3. Run "Setup Student Environment" automation
  4. 4. Students complete their profiles
  5. 5. Run "Generate & Deploy Portfolios" automation

Key Features

  • • One-click student portfolio generation
  • • Automated folder structure creation
  • • Professional HTML template generation
  • • Spotlight project management
  • • Multi-semester support
View Complete Instructor Guide

Key Features

Responsive Design

Professional portfolios that work on all devices

Automated Workflow

CSV upload to portfolio deployment in minutes

University Branding

Consistent Regis University visual identity

Troubleshooting

Site Not Loading

Problem: Deployed site shows 404 error

Solutions:

  • Wait 2-3 minutes after enabling Pages
  • Check that index.html is in the root directory
  • Verify branch is set to main in Settings → Pages
  • Clear browser cache

Student Data Not Appearing

Problem: Table shows "Loading..." indefinitely

Solutions:

  • Check data/cours_files.json syntax using a JSON validator
  • Open browser console (F12) to see error messages
  • Ensure JSON structure matches the multi-semester format

Images Not Loading

Problem: Broken image icons

Solutions:

  • Check file path (use relative paths: ../assets/img/photo.jpg)
  • Verify image file is uploaded to correct folder
  • Check file name spelling and case sensitivity
  • Ensure image format is supported (JPG, PNG, GIF, SVG)

Best Practices

For Students

  • Keep it Professional: Use appropriate language and imagery
  • Update Regularly: Keep your projects and CV current
  • Test Thoroughly: Check all links and features before sharing
  • Be Descriptive: Write clear project abstracts and descriptions

For Instructors

  • Set Guidelines: Provide clear instructions for students
  • Review Regularly: Check student submissions for quality
  • Curate Spotlights: Highlight exceptional work across semesters
  • Maintain Archive: Keep historical data organized by semester

Additional Resources

LaTeX Report Template

Professional template for MSDS 692/696 practicum reports

Access Template

Automation Repository

Access the regis_std repository for CSV workflows and automation

View Repository