Skip to content

Commit 017fd4a

Browse files
Update based on Fliss comments
1 parent b7ee9d4 commit 017fd4a

File tree

2 files changed

+32
-77
lines changed

2 files changed

+32
-77
lines changed

_toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,11 +317,11 @@ parts:
317317
- caption: Join Us!
318318
chapters:
319319
- file: contributing/community
320-
- file: contributing/new_course_checklist_timeline
321320
- file: contributing/contributing
322321
- file: contributing/roles
323322
- file: contributing/contributing_guidelines
324323
- file: contributing/developing_a_course
324+
- file: contributing/new_course_checklist_timeline
325325
- file: contributing/suggestions_form
326326

327327
- caption: Community Guidelines and Policy Information

contributing/new_course_checklist_timeline.ipynb

Lines changed: 31 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -9,103 +9,58 @@
99
"\n",
1010
"## Timescales & Ordering\n",
1111
"\n",
12-
"- **12 weeks before launch** \n",
13-
" - Hold initial logistics call with Programme Management to define learning objectives, course scope, and high-level timeline \n",
14-
" - Confirm roles (Developer, Lead, Helper) and schedule regular check-ins \n",
12+
"### **12 weeks before delivery** \n",
13+
" - Hold initial logistics call with Programme Management to define learning objectives, course scope, and high-level timeline\n",
14+
" - Confirm roles (Developer, Lead, Helper) and schedule regular check-ins\n",
15+
" - Create a feature branch on the [CfRR_Courses repo](https://github.com/coding-for-reproducible-research/CfRR_Courses), alongside a GitHub Issue \n",
16+
" - Developer begins drafting core materials \n",
17+
"\n",
18+
"#### Checklist Steps \n",
19+
"- [ ] Schedule and hold **initial logistics call** with Programme Management and Delivery Team \n",
20+
"- [ ] Define roles: Developer, Leader, Helper, Participant, Programme Management, and schedule a recurring meeting \n",
21+
"- [ ] Open GitHub Issue for the new course; create feature branch \n",
22+
"- [ ] Draft **course objectives** and detailed **learning objectives** for each section of the course\n",
1523
"\n",
16-
"- **10 weeks before launch** \n",
17-
" - Developer begins drafting core materials (notebooks, slides, datasets, etc.) \n",
18-
" - Create a feature branch on the [CfRR_Courses repo](https://github.com/coding-for-reproducible-research/CfRR_Courses) \n",
1924
"\n",
20-
"- **5 weeks before launch** \n",
21-
" - Submit the first complete draft of materials for internal review \n",
25+
"### **6 weeks before delivery** \n",
26+
" - Submit the first complete draft of materials for internal review. Liam Berrisford (@liamjberrisford) to validate website functionality (including accessibility features), then a separate reviewer to verify that the course content itself is accurate and appropriate.\n",
2227
" - Draft metadata in `programme_information` and `section_landing_page` (titles, descriptions, prerequisites) \n",
2328
" - Create the “Where Is My Understanding?” quiz; confirm the quiz `JSON` files render via `JupyterQuiz`\n",
24-
" - Conduct accessibility review (alt text, colour contrast, headings, tables) \n",
2529
"\n",
26-
"- **4 weeks before launch** \n",
27-
" - Integrate content into `JupyterBook`; perform a dry-run build on staging \n",
28-
" - Link all assets (images, data files, interactive widgets) \n",
29-
" - Add course pages to `_toc.yml` \n",
30-
" - If non-Python kernels are used, add them to the non-run list in `_config.yml` \n",
31-
"\n",
32-
"- **1 week before launch** \n",
33-
" - Freeze content; perform final proofreading and complete “top-to-bottom” code execution \n",
34-
" - Hold sign-off meeting with Programme Management \n",
35-
" - Merge the feature branch and add the new course to the live website \n",
3630
"\n",
37-
"- **Post-launch (within 1 week)** \n",
38-
" - Collect initial learner feedback via online form; log any issues as GitHub issues \n",
39-
" - Plan the first update cycle based on participant feedback \n",
40-
"\n",
41-
"## Checklist\n",
42-
"\n",
43-
"### Logistics & Planning\n",
44-
"- [ ] Schedule and hold **initial logistics call** with Programme Management and Delivery Team \n",
45-
"- [ ] Define roles: Developer, Leader, Helper, Participant, Programme Management \n",
46-
"- [ ] Open GitHub Issue for the new course; create feature branch \n",
47-
"\n",
48-
"### Content Creation & Structure\n",
49-
"- [ ] Draft **course objectives** and detailed **learning objectives** for each section of the course\n",
50-
"- [ ] Develop Jupyter notebooks (`.ipynb`) for Python or learnr tutorials (`.Rmd`) for R. Other types of course should be discussed with the central CfRR team\n",
51-
"- [ ] Include slides or PDFs as needed; confirm static content links \n",
52-
"\n",
53-
"### Metadata & Site Integration\n",
31+
"#### Checklist Steps\n",
5432
"- [ ] Populate `programme_information` \n",
5533
"- [ ] Populate `section_landing_page`\n",
5634
"- [ ] Populate `where_is_my_understanding`\n",
57-
"- [ ] Ensure no overlap or missing sections \n",
58-
"\n",
59-
"### Rendering & Functionality\n",
60-
"- [ ] Build with Jupyter Book on the PR; confirm notebooks render without errors \n",
35+
"- [ ] Add course pages to `_toc.yml` \n",
36+
"- [ ] Ensure no overlap or missing sections \n",
6137
"- [ ] Test interactive plots, embedded HTML, and widgets \n",
6238
"- [ ] Validate “Where Is My Understanding?” quiz (`display_quiz(\"path/to/quiz.json\")`) \n",
63-
"\n",
64-
"### Asset Linking & URL Encoding\n",
6539
"- [ ] Verify all file paths (spaces, special characters) are realtive paths as used in JupyterBook\n",
6640
"- [ ] Confirm images, data files, and HTML assets load correctly \n",
67-
"\n",
68-
"### Accessibility & Style\n",
69-
"- [ ] Use descriptive headings (H1–H3) and labels \n",
70-
"- [ ] Provide concise alt text for all images \n",
71-
"- [ ] Check colour contrast with a Contrast Checker \n",
72-
"- [ ] Avoid conveying information by colour alone; add text indicators, change shapes of points etc \n",
73-
"- [ ] Use clear, simple language and accessible tables \n",
74-
"\n",
75-
"### Testing & QA\n",
41+
"- [ ] Include slides or PDFs as needed; confirm static content links \n",
7642
"- [ ] Execute all notebooks end-to-end \n",
7743
"- [ ] Peer-review code comments and markdown explanations \n",
78-
"- [ ] Conduct cross-browser and device checks \n",
79-
"\n",
80-
"\n",
81-
"## Highlighting Issues\n",
8244
"\n",
83-
"Auditing materials refreshes your understanding and helps improve accuracy. Types of issues include: \n",
84-
"- Typographical errors \n",
85-
"- Factual errors \n",
86-
"- Content clarity and comprehension \n",
87-
"- Formatting and layout issues \n",
88-
"- Technical errors (broken links, non-functional elements) \n",
89-
"- Cultural and bias concerns \n",
90-
"- Outdated content \n",
91-
"- Logical fallacies or reasoning errors \n",
9245
"\n",
93-
"## Ensuring Understanding\n",
94-
"- **Multiple-Choice Questions** via JupyterQuiz (`display_quiz(\"path/to/quiz.json\")`) \n",
95-
"- **Coding Exercises** with clear instructions, hints, and dropdown solutions (use Jupyter Book admonitions) \n",
96-
"\n",
97-
"## Language-Specific Standards\n",
46+
"### **4 weeks before delivery** \n",
47+
" - Confirm that all feedback and change requests from the internal review have been addressed\n",
48+
" - Link all assets (images, data files, interactive widgets) \n",
9849
"\n",
99-
"### Python\n",
100-
"- Use Jupyter notebooks (`.ipynb`) with well-commented code and markdown \n",
101-
"- Include visualizations, interactive elements, and test notebooks end-to-end \n",
50+
"#### Checklist Steps\n",
51+
"- [ ] Confirm there is no outstanding feedback to be actioned from the internal review \n",
52+
"- [ ] Ensure that the Continuous Integration (CI) in the PR for building the Jupyter Book (website) and Accessibility passes\n",
10253
"\n",
103-
"### R\n",
104-
"- Use learnr tutorials (`.Rmd`) distributed via the `cfrr-r-tutorials` repo \n",
105-
"- Define prerequisites, embed interactive exercises/quizzes, and self-contain data and instructions \n",
10654
"\n",
55+
"### **2 week before delivery** \n",
56+
" - Freeze content; perform final proofreading and complete “top-to-bottom” code execution \n",
57+
" - Please notify Liam Berrisford (@liamjberrisford) that the content is ready for integration into the website and request his final review prior to publication.\n",
58+
" - Merge the feature branch and add the new course to the live website\n",
10759
"\n",
108-
" \n"
60+
"#### Checklist Steps\n",
61+
"- [ ] Perform a final proofreading pass; execute a full “top-to-bottom” run of all notebooks \n",
62+
"- [ ] Notify Liam Berrisford (@liamjberrisford) that materials are ready for integration and request his final sign-off \n",
63+
"- [ ] Once approved, merge the feature branch into main and deploy the new course to the live website "
10964
]
11065
},
11166
{

0 commit comments

Comments
 (0)