How ubc-cs/cpsc330-2024w2 works
Main Components
• Course Homepage & Static Website – At the top level there are core files such as README.md, _config.yml, _toc.yml, and the _static folder (with extra.css) that indicate that the site is built with a static-site generator (likely Jekyll in this case). Include a “Static Site Builder” or “Jekyll Engine” component.
• Documentation & Course Materials – The docs directory contains guides, instructions, and supplemental documents; the syllabus.md, learning-objectives.md, and other files act as reference material. They can be grouped as “Course Documentation & Reference.”
• Lecture Content & Notebooks – The lectures folder is extensive and subdivided into directories (e.g., different instructor lecture series, notes, tutorials, and even demo code in lectures/code). This represents the bulk of the course’s educational content.
• Deployment & CI/CD – The presence of GitHub workflows (in .github/workflows) and a file like cpsc330env.yml indicate that the site is built and deployed automatically. This component (“Deployment Pipeline/CI”) shows the continuous deployment process triggering website regeneration and publishing.
Relationships
• The “Lecture Code & Data Assets” may be highlighted as supportive components for demonstration materials or as embedded interactive examples within the lectures.
• “Deployment Pipeline/CI” as a pipeline that watches the repository for commits/merge events. Show directional flows from the repository (and its file tree) through GitHub Actions to the final deployment destination (such as GitHub Pages or an educational portal).
Architectural Patterns & Design Principles
• Separation of concerns is visible: The content is split between static website components, lecture notebooks, and supporting code/data. Each is organized in its own folder structure.
• Use of a static site generator (via _config.yml and _toc.yml) and continuous deployment (via GitHub workflows) exemplifies modern DevOps practices for educational sites.
• The consistent directory naming (docs, lectures, lectures/code, lectures/data) shows a modular approach to managing course assets.
• The project leverages external services (YouTube, Canvas, Gradescope) which should be displayed as part of an overall integration pattern.
Relevant Technologies & Frameworks
• Jekyll or similar static site generator (configured via _config.yml and _toc.yml)
• GitHub Actions for CI/CD deployment (configured in .github/workflows)
• Markdown, Jupyter Notebooks (for interactive lecture content), and PDF documents for course materials.
• Python scripts for code demonstrations and data processing within lectures.