Skip to content

kshannon-ucsd/cogs9

Repository files navigation

Deploy Jekyll site to Pages

cogs9

Class Website for UCSD's COGS 9 Introduction to Data Science

Up and Running

Dev Environment initial set up

  1. Install chruby and ruby-install with Homebrew (install ruby 3.1.2)
  2. cd to project dir and chruby for ruby-3.1.2 #this should be default from the .ruby-version file going forward.
  3. bundle init to create gemfile
  4. Set up gems to be installed locally in project dir: bundle config set --local path 'vendor/bundle' This creates a .bundle file
  5. Install Jekyll 4.2: bundle add jekyll At this time (9/5/2022) 4.2 auto installs
  6. Create jekyll scaffold: bundle exec jekyll new --force --skip-bundle . bundle install
  7. bundle add webrick
  8. Give it a test run by following the local dev build instructions below!

Building for Local

All dev builds will be built into a dev-docs/ dir. This dir is included in .gitignore and is only used for development builds. Any specific dev config should bd included in the _config_dev.yml file. Your absolute path to dev-docs will be different.

  1. bundle exec jekyll serve --config _config.yml,_config_dev.yml --destination ./dev-docs #builds and starts local server on localhost
  2. navigate to http://localhost:4000/cogs9/

Building for Prod

  1. A merge or direct push to main branch will automatically trigger the jekyll workflow which will build and deploy the main branch to production.
  2. Check status in github actions for build results.
  3. Navigate to https://kshannon-ucsd.github.io/cogs9/

/data/ directory

This dir is excluded from the jekyll build chain (excluded in the config.yaml file).

This folder includes data that changes from quarter to quarter, e.g. course calender. I don't want to recreate these data, so I dump them here to use for later. Eventually I would like to create variables to pull this data, but for now this is a fine solution.

Course Calendar

The following tags can be applied within a row for each course activity, set within the _data/term/course_calendar.csv file.

  • LECT --> Lecture
  • GLCT --> Guest Lecture
  • CNCL --> Cancelled class
  • ASSG --> Assignment
  • EXAM --> Exam
  • QUIZ --> Quiz
  • EXTR --> Extra Credit
  • PROJ --> Project

Any other tag used will default to a black colored tag