Merge branch 'main' into 'main'

Update checklist

See merge request rc-data-science/communications/dsjc-course!2

.gitlab-ci.yml

-image: alpine:latest
-
-pages:
-  stage: deploy
-  script:
-  - echo 'Nothing to do...'
-  artifacts:
-    paths:
-    - public
-  only:
-  - main

data_science_journal_club_checklist.md

 # DSJC New Session Checklist
 
-The intent is to have the course run every session each year: Fall, Spring, Summer. The UAB Academic Calendar dictates when classes start for each session, and the goal should be to have the course published the week before classes start.
-
-Instructor of Record: Kristina M. Visscher <mailto:kmv@uab.edu>
-
-UAB Academic Calendar: <https://www.uab.edu/students/academics/academic-calendar>
-
-## The Checklist
-
-- [ ] Merge GBSC and IDNE sections. Requires a ticket via course instructor Kristina Visscher <mailto:kmv@uab.edu>.
-- [ ] Add course TAs and instructors as needed. Requires a ticket via course instructor Kristina Visscher <mailto:kmv@uab.edu>. This must occur _after_ the merger! Please instruct central IT on this point.
-- [ ] Upload the [syllabus](data_science_journal_club_syllabus.html)
-  - Click the `</>` symbol at the bottom-right of the big text box and copy-paste the HTML (linked above) into the box. Click the symbol again to verify the formatting is correct.
-  - Show Course Summary: checked
-  - **Manually verify all links!**
-- [ ] Set up the [assignments](data_science_journal_club_assignment.html)
-  - Assignment name e.g. `Demonstration #1`
-  - Click the `</>` symbol at the bottom-right of the big text box and copy-paste the HTML (linked above) into the box. Click the symbol again to verify the formatting is correct.
-  - **Change the "Syllabus" link to the new course syllabus URL.**
-  - Points: `1`
-  - Display Grade as: `Complete/Incomplete`
-  - Submission Type: `No Submission`
-  - Group Assignment: unchecked
-  - Peer Reviews: unchecked
-  - Assign:
-    - Assign to: Everyone
-    - Due: last day of final exams according to the current session on <https://www.uab.edu/students/academics/academic-calendar>
-    - Available from/until: blank
-  - Click save and publish! Ensure the assignments are published in the Assignments main page, with a green checkmark icon next to each.
-  Once the first one is created, go to the main Assignments page. Click the vertical three dots next to the assignment you created. Click "Duplicate" and go from there.
-  - **Manually verify all links!**
-- [ ] Adjust settings
+The course is a collaboration between Kristina Visscher of the UAB Department of Neurobiology and UAB IT Research Computing. The intent of the course is to provide a guided platform for self-motivated students to learn more about Data Science and its important accessory skills. Accessory skills include software development, programming, data engineering, image and signal processing, visualization development, and high performance computing.
+
+The course runs every session each year: Fall, Spring, Summer. The UAB Academic Calendar dictates when classes start for each session. As instructors, our goal should be to have the course published the week before classes start.
+
+## Course Setup Checklist
+
+Steps can be performed by any Instructors unless otherwise noted.
+
+- [ ] Merge GBSC and IDNE sections.
+  - Must be done by IOR.
+  - Please visit [Canvas: Course Cross-Listing SLA page](https://uabprod.service-now.com/service_portal?id=sc_cat_item&sys_id=393e9275377d630024a67c1643990e27).
+- [ ] Add course Teaching Assistants and Instructors as needed.
+  - Must be done by IOR _after_ merge step is complete! Otherwise, adds may need to be redone.
+  - Please visit [Canvas: Add/Remove User(s) SLA page](https://uabprod.service-now.com/service_portal?id=sc_cat_item&sys_id=76f97b59374a670024a67c1643990ece).
+- [ ] Upload [Syllabus HTML](data_science_journal_club_syllabus.html)
+  1. Navigate to Syllabus page.
+  2. Switch text entry box to raw HTML mode by clicking `</>` symbol at bottom-right of box.
+  3. Copy-paste [HTML](data_science_journal_club_syllabus.html) into text entry box.
+  4. Switch to WYSIWYG mode: click `</>` symbol again.
+  5. Check "Show Course Summary" checkbox.
+  6. Verify formatting is correct.
+  7. **Manually verify all links by clicking them!**
+  8. Make a note of the Syllabus page URL for use with the Assignments page. _Not_ the Syllabus editing page!
+- [ ] Set up the [Assignments HTML](data_science_journal_club_assignment.html)
+  1. Update the Syllabus link in the [Assignment HTML](data_science_journal_club_assignment.html).
+      1. On the first line is an HTML tag that looks like `<a title="Syllabus" href="">`.
+      2. Copy-paste the Syllabus Page URL between the double quotes after `href=`.
+  2. Navigate to Assignments page.
+  3. Click "+ Assignment" button.
+  4. Enter Assignment Name in text entry box: `Demonstration #1`.
+  5. Switch text entry box to raw HTML mode by clicking `</>` symbol at bottom-right of box.
+  6. Copy-paste [HTML](data_science_journal_club_assignment.html) into text entry box.
+  7. Switch to WYSIWYG mode: click `</>` symbol again.
+  8. Set the following field values in the remainder of the form.
+      - Points: `1`
+      - Display Grade as: `Complete/Incomplete`
+      - Submission Type: `No Submission`
+      - Group Assignment: unchecked
+      - Peer Reviews: unchecked
+      - Assign:
+        - Assign to: `Everyone`
+        - Due: last day of final exams according to the current session on the [Academic Calendar](https://www.uab.edu/students/academics/academic-calendar)
+        - Available from/until: blank
+  9. Click save and publish!
+  10. Repeat steps (2) through (9) for `Demonstration #2` and `Demonstration #3`.
+      1. Go to the main Assignments page.
+      2. Click the vertical three dots next to the `Demonstration #1` assignment you created.
+      3. Click "Duplicate" and go from there.
+  11. Verify the assignments are published in the Assignments main page, with a green checkmark icon next to each.
+  12. **Manually verify all links by clicking them!**
+- [ ] Set up the [settings]
   - Course Details tab:
-    - Set appropriate start and end dates according to <https://www.uab.edu/students/academics/academic-calendar>
-    - End date should be at least one week after the last day of final exams so students may review their grades and course material
-    - Typically Canvas does a good job of picking these dates
+      1. Set appropriate start and end dates according to the [Academic Calendar](https://www.uab.edu/students/academics/academic-calendar).
+      2. End date should be at least one week after the last day of final exams so students may review their grades and course material
+      3. Typically Canvas does a good job of picking these dates
   - Navigation tab:
     - Disable all except:
       - Home
@@ -49,10 +69,45 @@ UAB Academic Calendar: <https://www.uab.edu/students/academics/academic-calendar
       - UAB Policies
       - Technology Resources
       - Student Academic and Support Services
-    - Put them in the above order
+    - Put them in the above order!
 - [ ] Use Student View to verify the course has appropriate appearance and function.
-  - Make sure syllabus looks good
-  - Make sure assignments are visible (they need to be published)
-  - **Manually verify all links!**
-- [ ] Publish the course. Requires the help of instructor Kristina Visscher <mailto:kmv@uab.edu>.
+  - Make sure syllabus looks correct.
+  - Make sure assignments are visible (they need to be published).
+  - **Manually verify all links by clicking them!**
+- [ ] Publish the course. May need to be done by IOR.
 - [ ] Make an announcement welcoming new students.
+  1. Navigate to Announcements Page.
+  2. Click `+ Announcements` button.
+  3. Enter Topic Title as "Welcome to the Data Science Journal Club course!"
+  4. Switch text entry box to raw HTML mode by clicking `</>` symbol at bottom-right of box.
+  5. Copy-paste [HTML](data_science_journal_welcome_announcement.html) into text entry box.
+  6. Switch to WYSIWYG mode: click `</>` symbol again.
+  7. Modify as necessary to be relevant to the current session.
+
+## Important Information
+
+### People
+
+| Course Title         | UAB Title                    | Name                 | email              |
+| :------------------- | :--------------------------- | :------------------- | :----------------- |
+| Instructor of Record | Associate Professor          | Kristina M. Visscher | <kmv@uab.edu>      |
+| Instructor           | RC Facilitator (Scientist I) | William Warriner     | <wwarr@uab.edu>    |
+| Instructor           | RC Facilitator (Scientist I) | Matthew Defenderfer  | <mdefende@uab.edu> |
+
+### Relevant Pages
+
+- UAB Academic Calendar: <https://www.uab.edu/students/academics/academic-calendar>
+
+### Abbreviations
+
+- **IOR**: Instructor of Record
+- **TA**: Teaching Assistant
+- **SLA**: Service Level Agreement
+- **WYSIWYG**: What You See Is What You Get
+  - Refers to a kind of text editor that lets you see what the resulting document will look like as you make changes.
+  - Microsoft Word is WYSIWYG.
+  - Most Canvas Page text entry boxes are WYSIWYG by default.
+
+## Notes on Using Canvas
+
+Most Canvas Page text entry boxes, including those of Syllabus and Assignments, have a WYSIWYG HTML editor. The entry mode can be changed to raw HTML mode by clicking the `</>` symbol at the bottom-right of the box. We use raw HTML mode extensively, allowing us to version control invidividual pages for the content of the course.
\ No newline at end of file