Skip to content

Commit d1de76b

Browse files
authored
chore(docs): update maintenance guide (#4093)
* Update maintenance guide * Fix capitalisation
1 parent de2f4a8 commit d1de76b

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

MAINTENANCE.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,26 @@ Create a new issue on GitHub with this checklist after the finals every semester
44

55
## Every Year
66

7-
- [ ] Update academic year and semester in `website/src/config/app-config.json`, and add current academic year to archive years
8-
- [ ] In `app-config.json`, update `examAvailability` to include only the semesters where exam information is available
9-
- [ ] Update with next year's holiday data from academic calendar to `website/src/data/holidays.json`
10-
- [ ] Singapore & NUS Holidays (e.g. Well-Being day): <https://www.nus.edu.sg/registrar/calendar>
11-
- [ ] Update `website/src/data/academic-calendar.json` with data for the new academic year
12-
- [ ] Add announcement to website by updating `website/src/data/holidays.json`
13-
- [ ] Update academic year in `scrapers/nus-v2/src/config.ts`
7+
### 1 week before NUS IT Data Update
8+
9+
- **Prepare "PR1"**
10+
- [ ] Update with next year's holiday data from academic calendar to `website/src/data/holidays.json` - Singapore & NUS Holidays (e.g. Well-Being day): <https://www.nus.edu.sg/registrar/calendar>
11+
- [ ] Update academic year in `scrapers/nus-v2/src/config.ts`
12+
- **Prepare "PR2"**
13+
- [ ] In `app-config.json`, update `examAvailability` to include only the semesters where exam information is available
14+
- [ ] Update `website/src/data/academic-calendar.json` with data for the new academic year
15+
- [ ] Add announcement to website by updating `website/src/data/holidays.json`
16+
17+
### 1-2 days before NUS IT Data Update
18+
19+
- [ ] **Merge "PR1"**
20+
- [ ] Push PR1 to production
21+
22+
### Day of NUS IT Data Update
23+
1424
- [ ] Ensure that scraper is scraping next AY's data. You can do so by checking the locally published JSON files, or visiting `https://api.nusmods.com/v2/20XX-20XX/` (e.g. [https://api.nusmods.com/v2/2022-2023/](https://api.nusmods.com/v2/2022-2023/))
1525
- [ ] On Vercel or `.env`: Update academic year in export service's environment variables
26+
- [ ] **Merge "PR2"** to Master > Production
1627
- [ ] Deploy! :tada: :tada:
1728
- [ ] Monitor Sentry and Telegram for issues
1829

0 commit comments

Comments
 (0)