Merge branch 'main' into dependabot/bundler/html-proofer-5.0.10

Author: bmcutler

Gemfile.lock

@@ -238,7 +238,7 @@ GEM
       gemoji (>= 3, < 5)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
-    json (2.10.1)
+    json (2.12.2)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)

_docs/developer/development_instructions/index.md

@@ -250,6 +250,15 @@ these changes.
   missing the hundreds of sample student submissions present in the
   full installation.
 
+  You can append the `--test_only_grading` flag to the above command to
+  more closely mimic the version that is on the Cypress CI.
+
+  If you only need a certain courses, you can append each course name to
+  the above command to only create the courses you want.
+
+  _NOTE: If you mistype a course, that course will not be created. If you
+  only have mistyped courses, then no courses gets created._
+
 
   NOTE: This command will also have to be run twice a year on July 1st and January 1st when the test semester will change from fall to spring or vice versa.
 

_docs/developer/getting_started/project_ideas.md

@@ -7,19 +7,19 @@ redirect_from:
 
 
 [comment]: <> We are thrilled to announce that Submitty has been accepted to [Google
-[comment]: <> Summer of Code (GSoC) 2024](https://summerofcode.withgoogle.com/).
+[comment]: <> Summer of Code (GSoC) 20XX](https://summerofcode.withgoogle.com/).
 [comment]: <> See [Submitty GSoC Application &
 [comment]: <> Reports](/developer/google_summer_of_code/index) for more information
 [comment]: <> about the application process and to read reports from Submitty GSoC
 [comment]: <> contributors in past summers.
 
-Submitty has been a participating organization of [Google Summer of
-Code](https://summerofcode.withgoogle.com/) for six successful
-seasons.  [We have applied for selection for Summer 2025](/developer/google_summer_of_code/index)
-and our
-Project Ideas list below has been updated.  The organizations selected
-for Summer 2025 Google Summer of Code will be announced in late
-February.
+[comment]: <> Submitty has been a participating organization of [Google Summer of
+[comment]: <> Code](https://summerofcode.withgoogle.com/) for six successful
+[comment]: <> seasons.  [We have applied for selection for Summer 20XX](/developer/google_summer_of_code/index)
+[comment]: <> and our
+[comment]: <> Project Ideas list below has been updated.  The organizations selected
+[comment]: <> for Summer 20XX Google Summer of Code will be announced in late
+[comment]: <> February.
 
 The project ideas listed below target a variety of different topics
 and require different levels of prior experience.  The scope of these

_docs/developer/google_summer_of_code/GSoC_application.md

@@ -0,0 +1,95 @@
+---
+title: GSoC Application
+category: Developer > Google Summer of Code 
+---
+
+## How to Apply to Submitty for Google Summer of Code 20XX
+
+1. Read the GSOC information for contributors to confirm your eligibility:  
+
+   * [https://summerofcode.withgoogle.com/](https://summerofcode.withgoogle.com/)  
+
+   * [https://developers.google.com/open-source/gsoc/faq#what_are_the_eligibility_requirements_for_participation](https://developers.google.com/open-source/gsoc/faq#what_are_the_eligibility_requirements_for_participation)
+
+2. Read our [Suggestions for New Developers](/developer).
+
+3. Follow the developer instructions to
+   [install the Submitty system](/developer/getting_started/vm_install_using_vagrant)
+   in a virtual machine on your computer.
+
+4. Review our project ideas list:   
+   [https://submitty.org/developer/getting_started/project_ideas](/developer/getting_started/project_ideas)
+
+5. Join our Zulip server to ask questions and meet other new developers:   
+   [https://submitty.org/contact](/contact)
+   
+   Ask specific technical questions about the Submitty system and open
+   issues and help answer technical questions from other new developers if
+   you think you can help.  Your engagement in the community discussion
+   during the application period (both asking and answering questions) will 
+
+
+   be taken into account as we evaluate your application.
+
+   NOTE: The Submitty mentors for Google Summer of Code are on our
+   Zulip server.  Please communicate through the public streams and
+   do not direct message (DM) / private message any mentors. 
+   Mentors will generally not respond to private messages.
+
+   New developers should start with an issue labeled "Good First Issue".
+   To understand the existing functionality/bug, reproduce and test this feature on your development VM.
+   Inspect the relevant system files and database contents.
+
+
+   NOTE:  More recent issues in the Submitty Github database tagged "Awaiting Triage"
+   have not yet been reviewed by the Submitty Project administrators.
+   These details of these bug reports and feature requests may need editing and revision
+   to confirm they meet with the long-term needs and goals of the Submitty project.
+   Before starting to work on one of these issues, we recommend you check with the
+   project team by creating a new discussion thread about the issue on our [Zulip server](/contact).
+
+7. Submit a pull request to solve an open issue.  
+   [https://submitty.org/developer/getting_started/make_a_pull_request](/developer/getting_started/make_a_pull_request)
+   
+8. Help test and review [open pull requests](https://github.com/Submitty/Submitty/pulls) contributed by other developers.
+   [https://submitty.org/developer/getting_started/review_a_pull_request](/developer/getting_started/review_a_pull_request)
+
+   NOTE: We always have a large number of _work-in-progress_ pull
+   requests from both new and experienced developers.  Prospective
+   developers with any level of experience are welcome and needed to
+   help review these PRs.  Contributing to the review process is
+   beneficial to everyone.
+
+9. Begin work on your GSoC Project application. We recommend
+    prospective contributors focus on one of our suggested projects
+    from the [project ideas](/developer/getting_started/project_ideas)
+    list. Successful applicants will be able to expand and enhance the
+    proposed project idea with a timeline of design and implementation
+    milestones, and will demonstrate curiosity and motivation for the
+    topic.
+
+10. Download and complete the
+    [Submitty GSoC Applicant Template](/developer/google_summer_of_code/applicant_template).
+   
+    You will document your skills, relevant coursework, non-course experience, and future
+    career goals that qualify you to work on this project.
+
+    The template will also ask for your approximate schedule for the
+    summer: start date, end date, and number of hours of work per week.
+    And a description of any classes, employment, or other time
+    commitments during that time period.  
+
+    Most importantly, you will summarize your engagement with the
+    Submitty project team during the application period.  This includes
+    participation in public discussions on our [Zulip server](/contact),
+    authoring of new pull requests (both in progress and merged), and
+    detailed and constructive reviews of PRs from other developers.
+
+
+11. The application window for Google Summer of Code closes on April XXth, 20XX at 18:00 UTC.
+   Please carefully read all of the program requirements.  
+   
+     * [Google Summer of Code 20XX Timeline](https://developers.google.com/open-source/gsoc/timeline)  
+
+     * [https://summerofcode.withgoogle.com/](https://summerofcode.withgoogle.com/)  
+

_docs/developer/google_summer_of_code/applicant_template.md

@@ -3,13 +3,13 @@ title: Applicant Template
 category: Developer > Google Summer of Code
 ---
 
-**NOTE: The 2025 Submitty GSoC Template will be available for download
-  when Google announces the organizations accepted for Google Summer
-  of Code 2025.**
+[comment]: <> **NOTE: The 20XX Submitty GSoC Template will be available for download
+[comment]: <>   when Google announces the organizations accepted for Google Summer
+[comment]: <>   of Code 20XX.**
 
 To ensure that the Submitty Org Admins and Mentors have all of the
 information about your ideas, project plan, and availability for
-Google Summer of Code 2025, we ask you to use the Submitty Applicant
+Google Summer of Code 20XX, we ask you to use the Submitty Applicant
 Template.
 
 The template will include:

_docs/developer/google_summer_of_code/index.md

@@ -5,125 +5,26 @@ redirect_from:
   - /developer/google_summer_of_code
 ---
 
-Submitty has applied for acceptance to 
-[Google
-Summer of Code (GSoC) 2025](https://summerofcode.withgoogle.com/).
-Project reports from participants in previous summers are linked
-below.
-
+[comment]: <> Submitty has applied for acceptance to
+[comment]: <> [Google Summer of Code (GSoC) 20XX](https://summerofcode.withgoogle.com/).
+[comment]: <> Project reports from participants in previous summers are linked
+[comment]: <> below.
 
 [comment]: <> We are thrilled to announce that Submitty has been accepted to [Google
-[comment]: <> Summer of Code (GSoC) 2024](https://summerofcode.withgoogle.com/).
+[comment]: <> Summer of Code (GSoC) 20XX](https://summerofcode.withgoogle.com/).
 [comment]: <> Project reports from participants in previous summers are linked
 [comment]: <> below.
 
-
-
 <center>
 <a href="https://summerofcode.withgoogle.com"><img src="/images/GSoC-Vertical.png" width="250px"></a>
 </center>
 
-[comment]: <> _NOTE: The organizations selected for Summer 2024 Google Summer of
-
-_NOTE: The organizations selected for Summer 2025 Google Summer of
-Code will be announced in late February.  The instructions below
-are from 2024 and will be updated if Submitty is accepted!_
-
-
-## How to Apply to Submitty for Google Summer of Code 2025
-
-1. Read the GSOC information for contributors to confirm your eligibility:  
-
-   * [https://summerofcode.withgoogle.com/](https://summerofcode.withgoogle.com/)  
-
-   * [https://developers.google.com/open-source/gsoc/faq#what_are_the_eligibility_requirements_for_participation](https://developers.google.com/open-source/gsoc/faq#what_are_the_eligibility_requirements_for_participation)
-
-   * [https://opensource.googleblog.com/2024/02/mentor-organizations-announced-for-google-summer-of-code-2024.html](https://opensource.googleblog.com/2024/02/mentor-organizations-announced-for-google-summer-of-code-2024.html)
-
-2. Read our [Suggestions for New Developers](/developer).
-
-3. Follow the developer instructions to
-   [install the Submitty system](/developer/getting_started/vm_install_using_vagrant)
-   in a virtual machine on your computer.
-
-4. Review our project ideas list:   
-   [https://submitty.org/developer/getting_started/project_ideas](/developer/getting_started/project_ideas)
-
-5. Join our Zulip server to ask questions and meet other new developers:   
-   [https://submitty.org/contact](/contact)
-   
-   Ask specific technical questions about the Submitty system and open
-   issues and help answer technical questions from other new developers if
-   you think you can help.  Your engagement in the community discussion
-   during the application period (both asking and answering questions) will 
-   be taken into account as we evaluate your application.
-
-   _NOTE: The Submitty mentors for Google Summer of Code are on our
-   Zulip server.  Please communicate through the public streams and
-   do not direct message (DM) / private message any mentors. 
-   Mentors will generally not respond to private messages._
-
-6. Search the Submitty Github for related open issues (bugs and feature requests):   
-   [https://github.com/Submitty/Submitty/issues](https://github.com/Submitty/Submitty/issues)
-
-   New developers should start with an issue labeled "Good First
-   Issue". To understand the existing functionality/bug, reproduce and
-   test this feature on your development VM. Inspect the relevant
-   system files and database contents.
-
-   _NOTE:  More recent issues in the Submitty Github database tagged "Awaiting Triage"
-   have not yet been reviewed by the Submitty Project administrators.
-   These details of these bug reports and feature requests may need editing and revision
-   to confirm they meet with the long-term needs and goals of the Submitty project.
-   Before starting to work on one of these issues, we recommend you check with the
-   project team by creating a new discussion thread about the issue on our [Zulip server](/contact)._
-
-7. Submit a pull request to solve an open issue.  
-   [https://submitty.org/developer/getting_started/make_a_pull_request](/developer/getting_started/make_a_pull_request)
-   
-8. Help test and review [open pull requests](https://github.com/Submitty/Submitty/pulls) contributed by other developers.
-   [https://submitty.org/developer/getting_started/review_a_pull_request](/developer/getting_started/review_a_pull_request)
-
-   NOTE: We always have a large number of _work-in-progress_ pull
-   requests from both new and experienced developers.  Prospective
-   developers with any level of experience are welcome and needed to
-   help review these PRs.  Contributing to the review process is
-   beneficial to everyone.
-
-9. Begin work on your GSoC Project application. We recommend
-    prospective contributors focus on one of our suggested projects
-    from the [project ideas](/developer/getting_started/project_ideas)
-    list. Successful applicants will be able to expand and enhance the
-    proposed project idea with a timeline of design and implementation
-    milestones, and will demonstrate curiosity and motivation for the
-    topic.
-
-10. Download and complete the
-    [Submitty GSoC Applicant Template](/developer/google_summer_of_code/applicant_template).
-   
-    You will document your skills, relevant coursework, non-course experience, and future
-    career goals that qualify you to work on this project.
-
-    The template will also ask for your approximate schedule for the
-    summer: start date, end date, and number of hours of work per week.
-    And a description of any classes, employment, or other time
-    commitments during that time period.  
-
-    Most importantly, you will summarize your engagement with the
-    Submitty project team during the application period.  This includes
-    participation in public discussions on our [Zulip server](/contact),
-    authoring of new pull requests (both in progress and merged), and
-    detailed and constructive reviews of PRs from other developers.
-
-
-11. The application window for Google Summer of Code closes on April 8th, 2025 at 18:00 UTC.
-   Please carefully read all of the program requirements.  
-   
-     * [Google Summer of Code 2025 Timeline](https://developers.google.com/open-source/gsoc/timeline)  
+[comment]: <> _NOTE: The organizations selected for Summer 20XX Google Summer of
+[comment]: <> Code will be announced in late February.  The instructions below
+[comment]: <> are from 20XX and will be updated if Submitty is accepted!_
 
-     * [https://summerofcode.withgoogle.com/](https://summerofcode.withgoogle.com/)  
 
-&nbsp;  
+[comment]: <> [Google Summer of Code Application](/developer/google_summer_of_code/GSoC_application)
 
 
 ## Google Summer of Code 2024

_docs/developer/testing/autograding_integration_tests.md

@@ -1,6 +1,6 @@
 ---
 title: Autograding Tests
-category: Developer
+category: Developer > Development Instructions > Continuous Integration Testing
 ---
 
 _NOTE: Currently, these tests can only be run from within Vagrant._

_docs/developer/testing/cypress.md

@@ -1,5 +1,6 @@
 ---
 title: End-to-End testing with Cypress
+category: Developer > Development Instructions > Continuous Integration Testing
 ---
 
 The _End-to-End Testing_ (e2e) suite utilizes [Cypress](https://www.cypress.io/),

_docs/developer/testing/external_contributors.md

@@ -0,0 +1,26 @@
+---
+title: External Contributors
+category: Developer > Development Instructions > Continuous Integration Testing
+---
+
+To run all Submitty workflows on a forked repository, you must manually trigger the workflow. This is because GitHub Actions do not run on forked repositories by default. One of the people in the Submitty organization must manually trigger the workflow for you. To avoid this, you can trust the workflow in your forked repository. This will allow GitHub Actions to run on your forked repository without manual intervention.
+
+---
+
+## Steps for External Contributors
+
+1. The first step is to visit [https://github.com/GITHUB_USERNAME/Submitty/actions](https://github.com/GITHUB_USERNAME/Submitty/actions) (or click the actions tab from your forked submitty repository) and click on the button labeled "I understand my workflows, go ahead and enable them".
+   ![GitHub UI to trust workflows in fork](/images/testing/fork_trust.png)
+
+2. After that, on the left side of the page, click on the workflow labeled "CI" to be able to run the workflow. Then, in the "Run workflow" dropdown, select the branch you want to run the workflow on and click the green "Run workflow" button.
+   ![GitHub UI to manually trigger workflow](/images/testing/fork_dispatch.png)
+3. Congratulations! You have successfully triggered the workflow on your forked repository. You should now see a new started workflow in the list of workflows.
+   ![GitHub UI to view workflow run](/images/testing/fork_workflow_run.png)
+
+---
+
+These steps are drawn from:
+
+[https://github.com/github/docs/issues/15761](https://github.com/github/docs/issues/15761)
+
+[https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow)

_docs/developer/testing/github_actions.md

@@ -1,5 +1,6 @@
 ---
 title: GitHub Actions
+category: Developer > Development Instructions > Continuous Integration Testing
 ---
 
 We utilize [GitHub actions](https://docs.github.com/en/actions) to enable *continuous integration*