From f53641ac27e57f8079dfab32dbfb41a3955010e4 Mon Sep 17 00:00:00 2001 From: Gabe Salmon Date: Fri, 23 Aug 2024 11:53:40 -0700 Subject: [PATCH] Update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index abb3d5d..1271ca6 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ## How to update/archive website material Say we're in year 20XX. To make a new year's offering course webpage for the new year 20XX+1: -1. First, archive the current/old year's `index.html` page. Do this by making a new directory called the current year, '20XX', and copying ~the current `index.html` file held at the top level of this `be262` directory into the new directory. (The logic of the whole webpage is that whatever `index.html` is found at the top level is the one served by github pages to visitors to the webpage without a year suffix.)~ +1. First, archive the current/old year's `index.html` page. Do this by making a new directory called the current year, '20XX', and copying the current `index.html` file held at the top level of this `be262` directory into the new directory. (The logic of the whole webpage is that whatever `index.html` is found at the top level is the one served by github pages to visitors to the webpage without a year suffix.) * Note: not essential to get a functional `20XX+1` page up and running, but: to properly archive the old websites so references are intact, you must also copy the contents of `_site/20XX/` into the `_site/20XX+1` folder. 2. Next, edit the `index.html` file still at the top level of `be262` to indicate the new year, by changing `year: 20XX` to `year: 20XX+1`. 3. Now, go to the `_posts` directory. This directory contains the majority of files you would be updating the content of that comprise the website (eg those `About`, `People`, `Programming`, and `Readings` links that populate the left side of the webpage). The webpage framework essentially expects a structure like a blog, so each of the Markdown files in `_posts` contains a date. These dates are arbitrary, except for the fact that the current year's posts must all have the current numerical year correctly specified. So, copy the old/current year's posts---namely, eg `20XX-01-24-readings.md`, `20XX-01-25-code.md`, and so on---into new versions that are renamed with the new year, e.g. `20XX+1-01-24-readings.md`, etc. Next, inside each of these year `20XX+1` post .md files, edit anything that says the old `20XX` year into `20XX+1`: e.g. at the minimum the `tag:` and `year:` attributes at the top of each of the files. But also, for e.g. the `20XX+1-01-24-code.md` file, you'll need to edit a mention in `site.data.20XX.speakers` to `site.data.20XX+1.speakers`, etc.