diff --git a/Gemfile b/Gemfile index b22fc38..02c767f 100644 --- a/Gemfile +++ b/Gemfile @@ -16,7 +16,7 @@ group :jekyll_plugins do gem 'jekyll-redirect-from' gem 'jekyll-sitemap' gem 'jemoji' - gem 'just-the-docs' + gem 'just-the-docs', "0.10.0" end # These tools are use for running tests. diff --git a/Gemfile.lock b/Gemfile.lock index 30c1d8a..8526cbb 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -125,7 +125,7 @@ GEM html-pipeline (~> 2.2) jekyll (>= 3.0, < 5.0) json (2.7.2) - just-the-docs (0.9.0) + just-the-docs (0.10.0) jekyll (>= 3.8.5) jekyll-include-cache jekyll-seo-tag (>= 2.0) @@ -266,7 +266,7 @@ DEPENDENCIES jekyll-redirect-from jekyll-sitemap jemoji - just-the-docs + just-the-docs (= 0.10.0) kramdown-parser-gfm rack rackup diff --git a/logistics/course-site.md b/course-software/course-site.md similarity index 62% rename from logistics/course-site.md rename to course-software/course-site.md index de5c75e..585177b 100644 --- a/logistics/course-site.md +++ b/course-software/course-site.md @@ -1,16 +1,15 @@ --- layout: page title: Course Webpages -parent: Course Logistics -nav_order: 2 +parent: Course Software +nav_order: 3 --- # Course Webpages ## Templates -- [Berkeley Class Site Template with Accessibility Checks](https://github.com/berkeley-cdss/berkeley-class-site) -- [CS 161 Course Site Template](https://github.com/cs161-staff/course-site-template) +In the addition to the [templates maintained by Seamless Learning](../seamless-learning/course-websites), CS 161 also maintains a [Jekyll based template](https://github.com/cs161-staff/course-site-template) ## Accessibility Resources @@ -19,4 +18,4 @@ You are responsible for ensuring that your webpage is accessible. This is both t - [Digital Accessibility Program](https://dap.berkeley.edu/) - [WCAG Standards](https://www.w3.org/WAI/standards-guidelines/wcag/) -- [Color Contrast Checker](https://webaim.org/resources/contrastchecker/) \ No newline at end of file +- [Color Contrast Checker](https://webaim.org/resources/contrastchecker/) \ No newline at end of file diff --git a/ed.md b/course-software/ed.md similarity index 99% rename from ed.md rename to course-software/ed.md index 83f2246..1560301 100644 --- a/ed.md +++ b/course-software/ed.md @@ -1,7 +1,8 @@ --- layout: page title: EdStem -nav_order: 5 +parent: Course Software +nav_order: 4 published: true --- diff --git a/course-software/index.md b/course-software/index.md new file mode 100644 index 0000000..950fb35 --- /dev/null +++ b/course-software/index.md @@ -0,0 +1,12 @@ +--- +layout: page +title: Course Software +nav_order: 5 +has_toc: true +--- + +# Course Software + +## Quick Links + +- [Data Science Curriculum Guide](https://curriculum-guide.datahub.berkeley.edu/): Information for instructors who teach or will teach a course using UC Berkeley DataHub and students enrolled in courses that use DataHub and want to learn more. ([GitHub](https://github.com/berkeley-cdss/curriculum-guide)) diff --git a/otter/gradescope-debug.md b/course-software/otter/gradescope-debug.md similarity index 98% rename from otter/gradescope-debug.md rename to course-software/otter/gradescope-debug.md index 4838980..40fe1e6 100644 --- a/otter/gradescope-debug.md +++ b/course-software/otter/gradescope-debug.md @@ -2,12 +2,11 @@ layout: page title: Gradescope Debugging via SSH parent: Otter Grader -nav_order: 2 --- # Otter-Gradescope Debugging -Downloading a student's graded submission concatenates the output from the autograder and a PDF copy of the student's submitted `.ipynb`. This PDF of the `.ipynb` will have the output from public tests run on datahub (or wherever the student completed the assignment); it will not have the output from the autograder running in the grading container. +Downloading a student's graded submission concatenates the output from the autograder and a PDF copy of the student's submitted `.ipynb`. This PDF of the `.ipynb` will have the output from public tests run on datahub (or wherever the student completed the assignment); it will not have the output from the autograder running in the grading container. It is possible that the grading container may have a different environment than datahub (or wherever the student completed the assignment) if `requirements.txt` is out of date. **We do not recommend running student submissions locally,** and it is also possible that the environment is different than whatever you may have locally. @@ -53,5 +52,4 @@ Note: If you open a terminal from JupyterLab you will need to rerun `conda activ 1. Move `executed.ipynb` from the `results` directory into the `submission` directory. This ensures you have access to any associated files and allows otter commands to run without issue. -2. You may need to adjust the kernel to use the virtual environment `otter-env`. - +2. You may need to adjust the kernel to use the virtual environment `otter-env`. diff --git a/otter/index.md b/course-software/otter/index.md similarity index 93% rename from otter/index.md rename to course-software/otter/index.md index 4c8341e..a94c08d 100644 --- a/otter/index.md +++ b/course-software/otter/index.md @@ -1,9 +1,9 @@ --- layout: page title: Otter Grader -nav_order: 7 +nav_order: 2 +parent: Course Software has_toc: true -has_children: true --- # Otter Grader Help diff --git a/otter/releasing-assignment.md b/course-software/otter/releasing-assignment.md similarity index 96% rename from otter/releasing-assignment.md rename to course-software/otter/releasing-assignment.md index 53d63a3..78c5267 100644 --- a/otter/releasing-assignment.md +++ b/course-software/otter/releasing-assignment.md @@ -2,11 +2,10 @@ layout: page title: Releasing an Assignment parent: Otter Grader -nav_order: 1 ---
-This page is a work in progress. This is only the first draft. +This page is a work in progress. This is only the first draft.
# Releasing an Assignment using Otter Grader @@ -18,7 +17,7 @@ Note: If you are working on an assignment that will be released to students on a ## Before the start of the semester 1. Review what Python packages your class is using. - * If you are not developing or altering assignments, you can use files like `requirements.txt` and look at your `import` statements. + * If you are not developing or altering assignments, you can use files like `requirements.txt` and look at your `import` statements. * For a systematic way to gather this information, we'll later provide a notebook that gathers all requirements into a a text file. 2. Check that all Python packages are available on the DataHub offering that your course is using. @@ -36,7 +35,7 @@ numpy.__version__ We recommend running `otter assign` on DataHub. We do NOT recommend running this command locally. You can clone the development repo in DataHub via the command line/terminal. It is safe to do so; you do not need to worry about students accidentally getting access to solutions. -Ensure that the solution runs on DataHub without issue; i.e. "Run All Cells" on the solution notebook generated from `otter assign`. +Ensure that the solution runs on DataHub without issue; i.e. "Run All Cells" on the solution notebook generated from `otter assign`. Only push to the student facing repository once all changes have been made. You don't want to accidentally break an nbgitpuller link. diff --git a/course-software/seamless-learning/assignment-snapshots.md b/course-software/seamless-learning/assignment-snapshots.md new file mode 100644 index 0000000..31fbbd5 --- /dev/null +++ b/course-software/seamless-learning/assignment-snapshots.md @@ -0,0 +1,15 @@ +--- +layout: page +title: Assignment Snapshots +parent: Seamless Learning +nav_order: 7 +--- + +# Assignment Snapshots + +{: .warning } +This project is currently in development. + +Features a script to mass download [OkPy](https://okpy.org) backups and a full-stack web application to view and analyze student backups. + +- [GitHub repository](https://github.com/berkeley-cdss/assignment-snapshots) diff --git a/course-software/seamless-learning/course-websites.md b/course-software/seamless-learning/course-websites.md new file mode 100644 index 0000000..cb1cab8 --- /dev/null +++ b/course-software/seamless-learning/course-websites.md @@ -0,0 +1,33 @@ +--- +layout: page +title: Course Websites +parent: Seamless Learning +nav_order: 4 +--- + +# Course Websites + +## Berkeley Class Site + +The Berkeley Class Site template is a modern, web accessible, Jekyll-based static course website template forked from [Kevin Lin's just-the-class template](https://github.com/kevinlin1/just-the-class), which itself uses the [just-the-docs](https://just-the-docs.com/) theme. + +It features all the benefits of Jekyll (fast development, builds, and GitHub Pages deployment) as well as Berkeley-specific +features such as a web accessibility GitHub Actions workflow and ready-to-use Jekyll collections for announcements, +lectures, assignments, and staff bios. + +- [GitHub repository](https://github.com/berkeley-cdss/berkeley-class-site) +- [Documentation](https://berkeley-cdss.github.io/berkeley-class-site/docs/) +- [Live Berkeley Class Site website](https://berkeley-cdss.github.io/berkeley-class-site/) + +## Quarto Course Site Template + +Statistics courses may prefer a Quarto-based course site template. Seamless Learning maintains two depending on your use case: + +- [Quarto Course Site Template](https://github.com/berkeley-cdss/course-site-quarto) +- [Minimal Quarto Course Site Template](https://github.com/berkeley-cdss/course-site-quarto-lite) + +## MyST Course Site Template + +Statistics courses may also prefer a MyST-based course site template: + +- [GitHub repository](https://github.com/berkeley-cdss/course-site-myst) diff --git a/course-software/seamless-learning/exam-timer.md b/course-software/seamless-learning/exam-timer.md new file mode 100644 index 0000000..fd9ee29 --- /dev/null +++ b/course-software/seamless-learning/exam-timer.md @@ -0,0 +1,14 @@ +--- +layout: page +title: Exam Timer +parent: Seamless Learning +nav_order: 5 +--- + +# Exam Timer + +The Exam Timer (formerly from CS 61C) allows you to overlay a simple timer on top of a Google Doc, which is useful +for proctoring exams where you must display clarifications. + +- [GitHub repository](https://github.com/berkeley-cdss/exam-timer) +- [Exam Timer app](https://exam-timer.com/) \ No newline at end of file diff --git a/course-software/seamless-learning/extensions.md b/course-software/seamless-learning/extensions.md new file mode 100644 index 0000000..b66e46f --- /dev/null +++ b/course-software/seamless-learning/extensions.md @@ -0,0 +1,14 @@ +--- +layout: page +title: Extensions +parent: Seamless Learning +nav_order: 1 +--- + +# Extensions + +The extensions tool, sometimes called flextensions or formerly the CS 161 extensions tool, allows +instructors to review, approve, and implement extensions at scale. + +- [GitHub repository](https://github.com/berkeley-cdss/extensions) +- [Documentation](https://github.com/berkeley-cdss/extensions/wiki) diff --git a/course-software/seamless-learning/index.md b/course-software/seamless-learning/index.md new file mode 100644 index 0000000..728e6ce --- /dev/null +++ b/course-software/seamless-learning/index.md @@ -0,0 +1,20 @@ +--- +layout: page +title: Seamless Learning +parent: Course Software +nav_order: 1 +--- + +# Seamless Learning + +The [Seamless Learning](https://github.com/berkeley-cdss/seamless-learning) initiative run by [Lisa Yan](https://github.com/yanlisa) (yanlisa@) and [Michael Ball](https://github.com/cycomachead) (ball@) is an essential place for gathering staff, TAs, and faculty to discuss common issues. The documentation here is a direct result of Seamless Learning's efforts. + +All Seamless Learning tools are housed under the [berkeley-cdss](https://github.com/berkeley-cdss) GitHub organization. +Notable Seamless Learning projects are listed below. + +You can message any of the contributors on Slack on EECS/DS Crossroads or email us at [{{ site.email }}](mailto:{{ site.email }}). + +{: .highlight } +> Contributions Welcome +> +> We are proudly open-source and welcome all contributions. Existing work is the efforts of many past instructors and TAs. diff --git a/course-software/seamless-learning/seamless-bot.md b/course-software/seamless-learning/seamless-bot.md new file mode 100644 index 0000000..ca0002f --- /dev/null +++ b/course-software/seamless-learning/seamless-bot.md @@ -0,0 +1,16 @@ +--- +layout: page +title: Seamless Bot +parent: Seamless Learning +nav_order: 6 +--- + +# Seamless Bot + +{: .warning } +This project is currently in development. + +Streamline course management by effortlessly accessing summarized student performance reports, assignment progress via Gradescope integration, tracking unresolved threads on Ed, etc. using the Seamless Slackbot. + +- [GitHub repository](https://github.com/berkeley-cdss/seamless_bot) +- [Documentation](https://github.com/berkeley-cdss/seamless_bot/wiki) diff --git a/course-software/seamless-learning/seating.md b/course-software/seamless-learning/seating.md new file mode 100644 index 0000000..ae5f4bc --- /dev/null +++ b/course-software/seamless-learning/seating.md @@ -0,0 +1,15 @@ +--- +layout: page +title: Seating +parent: Seamless Learning +nav_order: 2 +--- + +# Seating + +The seating tool (formerly the CS 61A seating tool) allows instructors to have assigned exam seating that matches +students to a specific seat in a specific building while satisfying their preferences. + +- [GitHub repository](https://github.com/berkeley-cdss/seating) +- [Documentation](https://github.com/berkeley-cdss/seating/wiki) +- [Seating Tool app](http://seating.eecs.cloud/) diff --git a/course-software/seamless-learning/sections.md b/course-software/seamless-learning/sections.md new file mode 100644 index 0000000..4200360 --- /dev/null +++ b/course-software/seamless-learning/sections.md @@ -0,0 +1,13 @@ +--- +layout: page +title: Sections +parent: Seamless Learning +nav_order: 3 +--- + +# Sections + +The sections tool (formerly the CS 61A sections tool) allows instructors to manage discussion, lab, and/or tutoring sections and track attendance. + +- [GitHub repository](https://github.com/Cal-CS-61A-Staff/sections) +- [Sections Tool app (CS 61A instance)](https://sections.cs61a.org/) diff --git a/exams/index.md b/logistics/exams/index.md similarity index 58% rename from exams/index.md rename to logistics/exams/index.md index c81a4e5..054dd7e 100644 --- a/exams/index.md +++ b/logistics/exams/index.md @@ -1,12 +1,12 @@ --- layout: page title: Exams -nav_order: 4 -has_children: true +nav_order: 1 +parent: Course Logistics --- # Exams ## Quick Links -- [CS 161 Pedagogy Blog: How to Write Solid Exam Questions](https://pedagogy.cs161.org/2022/02/06/exam-writing-i/) \ No newline at end of file +- [CS 161 Pedagogy Blog: How to Write Solid Exam Questions](https://pedagogy.cs161.org/2022/02/06/exam-writing-i/) \ No newline at end of file diff --git a/exams/writing-exams.md b/logistics/exams/writing-exams.md similarity index 100% rename from exams/writing-exams.md rename to logistics/exams/writing-exams.md diff --git a/logistics/index.md b/logistics/index.md index 08f1754..20c6d76 100644 --- a/logistics/index.md +++ b/logistics/index.md @@ -1,8 +1,7 @@ --- layout: page title: Course Logistics -nav_order: 3 -has_children: true +nav_order: 4 --- # Course Logistics diff --git a/logistics/managing-the-course-email.md b/logistics/managing-the-course-email.md index f61b0ae..43e7a66 100644 --- a/logistics/managing-the-course-email.md +++ b/logistics/managing-the-course-email.md @@ -2,7 +2,7 @@ layout: page title: Managing Course Email parent: Course Logistics -nav_order: 1 +nav_order: 2 --- # Managing Course Email diff --git a/using-github/index.md b/using-github/index.md index 38b5a60..d7af7f4 100644 --- a/using-github/index.md +++ b/using-github/index.md @@ -1,8 +1,7 @@ --- layout: page title: Using GitHub -nav_order: 6 -has_children: true +nav_order: 3 --- # Using GitHub