Setup:
Setting up a new course repo in this format
So you want to set up a new course repo in this format. There are six cases, as shown in the table below:
Course-level-repo e.g. ucsb-cs24.github.io |
Instance repo e.g. ucsb-cs24.github.io/w19/ |
|
---|---|---|
Starting from scratch | instructions | instructions |
Starting from pre-W19 repo | instructions | instructions |
Starting from a previous post W19 repo | instructions | instructions |
The row in the table is determined by whether you are starting from scratch, or copying materials from a repo that already exists:
- If you are just getting started with this format, the “Starting from scratch” option is the only row you need to consult.
- If you are offering a course that has used this format before, and you are copying a repo from another instructor,
then the next question is whether that repo uses the new w19 and later format, or the old legacy format.
- If the
_config.yml
file of the repo hasjekyll-remote-theme
in it, then it’s the new format. - Otherwise, it’s the old pre-w19 format.
- If the
The column is determined by what kind of repo you are setting up:
- If you are setting up a site for a course that has never used this format before, you’ll actually follow the instructions in BOTH columns.
- If you are setting up a repo that serves as the base of the website, and holds material that is global across all offerings of the course, you want the first column.
- If you are setting up a repo for a particular instructor’s offering
of a course in a particular term, (e.g.
S19
orS19-mirza
), you want the second column.
Related topics:
- Setup: —Setting up a new course repo in this format
- Setup: Boilerplate—Files that you just copy directly
- Setup: Migrate Offering from previous offering—The most common case: copying from an existing offering in this format (e.g. F19 → W20)
- Setup: New Course—Setting up a new course level repo in this format
- Setup: New Offering—Creating a first offering of a course