Merge branch 'main' into add-troubleshooting-document

Author: hanyunguo

Gemfile.lock

@@ -213,7 +213,7 @@ GEM
       gemoji (>= 3, < 5)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
-    json (2.7.1)
+    json (2.7.2)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -231,6 +231,8 @@ GEM
     mutex_m (0.2.0)
     net-http (0.4.1)
       uri
+    nokogiri (1.16.3-arm64-darwin)
+      racc (~> 1.4)
     nokogiri (1.16.3-x86_64-linux)
       racc (~> 1.4)
     octokit (4.25.1)
@@ -274,6 +276,7 @@ GEM
     yell (2.2.2)
 
 PLATFORMS
+  arm64-darwin-22
   x86_64-linux
 
 DEPENDENCIES

_docs/developer/getting_started/vm_install_using_vagrant.md

@@ -93,7 +93,7 @@ If you using an Intel-based Mac, you will follow the instructions below._
 
    7. Enter your **BIOS** (generally by pressing Del, F12, or other keys while booting). If you are not able to find the key combo needed to enter your BIOS, refer to [this guide](https://www.tomshardware.com/reviews/bios-keys-to-access-your-firmware,5732.html).
 
-   8. Locate **Virtualization**, and enable it. (Note: If you cannot find the option to enable virtualization, [search Google](http://tinyurl.com/enable-virtualization) for a tutorial on enabling it with your motherboard.)
+   8. Locate **Virtualization**, and enable it. (Note: Some motherboards may call it SVM, AMD-V, VT-x/Vanderpool. If you cannot find the option to enable virtualization, [search Google](http://tinyurl.com/enable-virtualization) for a tutorial on enabling it with your motherboard.) 
 
    9. Reboot your computer.
 
@@ -102,7 +102,7 @@ If you using an Intel-based Mac, you will follow the instructions below._
 
    2. Navigate the **BIOS Settings**.
 
-   3. Locate **Virtualization** and enable it.
+   3. Locate **Virtualization** and enable it. (Some motherboards may call it SVM, AMD-V, VT-x/Vanderpool)
 
    4. Be sure to choose **Hardware Virtualization** in the **System -> Acceleration** settings of the virtual machine you are using.
 
@@ -169,17 +169,16 @@ Below are quick steps to get everything installed and running.
    when running vagrant up, use `vagrant up --provider=virtualbox` so it doesnt default to libvirt
 
    **Common errors when running vagrant up(Fedora/RHEL)**
-   1. Missing virtnetworkd:
-      Enable it in your terminal by running:
-      ```
-      sudo systemctl start virtnetworkd
-      ```
-   2. If your vagrant ever freezes kill it with 
-      '''
-      VBoxManage controlvm VM_NAME poweroff
-      '''
-      or if that doesn't work, reboot the computer and then run `vagrant destroy` before re-running `vagrant up --provider=virtualbox` again.
-
+      1. Missing virtnetworkd:
+         Enable it in your terminal by running:
+         ```
+         sudo systemctl start virtnetworkd
+         ```
+      2. If your vagrant ever freezes kill it with 
+         ```
+         VBoxManage controlvm VM_NAME poweroff
+         ```
+         or if that doesn't work, reboot the computer and then run `vagrant destroy` before re-running `vagrant up --provider=virtualbox` again.
 
 5. Clone [the Submitty repository](https://github.com/Submitty/Submitty) to a location on
    your computer (the "host").

_docs/index/people.md

@@ -10,6 +10,29 @@ redirect_from:
 
 ---
 
+## 2024 Spring Developers
+
+![](/images/people/2024_spring.png)
+
+Michael Krar,
+Joshua Wei,
+Jeffrey Cordero,
+Raymond Reynoso Ramirez,
+Ryan Varughese,
+Tate Whiteberg,
+Kush Raval,
+Josiah Riggins,
+Chris Reed,
+Johnny Chen,
+James Fitzgerald,
+Viane Matsibekker,
+Jaeseok Kang,
+Hanson Gu,
+Zheyu Deng,
+Junyi Wu
+
+---
+
 ## 2023 Fall Developers
 
 ![](/images/people/2023_fall.png)

_docs/instructor/assignment_preparation/index.md

@@ -249,3 +249,51 @@ you must re-run the BUILD_XXXX.sh script.
    logfiles for each test case.  You will also find log files for the
    compilation, runner, and validation components of automated grading
    that are helpful in debugging assignment configurations.
+
+
+### Download Gradeable as JSON
+
+You can download the JSON representation of your gradeable by clicking the 'Download Gradeable Json' 
+button at the top right of the 'Edit Gradeable' screen. This JSON file can be re-uploaded into a new course 
+to use the same parameters as the existing gradeable.
+
+Below is the list of parameters downloaded. VCS and Team Gradeable are only downloaded if the gradeable is using them. 
+```json
+{
+  "title": "Example Json",
+  "instructions_url": "",
+  "id": "Example ID",
+  "type": "Electronic File",
+  "vcs": {
+    "repository_type": "submitty-hosted",
+    "vcs_path": "http://localhost:1511/path/to/repository",
+    "vcs_subdirectory": "subdirectory"
+  },
+  "team_gradeable": {
+    "team_size_max": 3,
+    "inherit_from": "gradeable_id",
+  },
+  "bulk_upload": false,
+  "grading_inquiry": false,
+  "grade_inquiry_per_component_allowed": false,
+  "ta_grading": false,
+  "discussion_thread_id": "thread_id",
+  "syllabus_bucket": "Homework",
+  "autograding_config_path": "path/to/config",
+  "dates": {
+    "ta_view_start_date": "2024-1-10 23:59:59.00",
+    "submission_open_date": "2024-1-10 23:59:59.00",
+    "submission_due_date": "2024-2-10 23:59:59.00",
+    "grade_start_date": "2024-2-10 23:59:59.00",
+    "grade_due_date": "2024-3-10 23:59:59.00",
+    "team_lock_date": "2024-1-10 23:59:59.00",
+    "grade_released_date": "2024-3-10 23:59:59.00",
+    "grade_inquiry_start_date": "2024-3-10 23:59:59.00",
+    "grade_inquiry_due_date": "2024-3-10 23:59:59.00",
+    "has_due_date": true,
+    "has_release_date": true,
+    "late_days_allowed": true,
+    "late_days": 3
+  }
+}
+```

_docs/instructor/assignment_preparation/upload_gradeable.md

@@ -41,15 +41,50 @@ __Other Electronic Types__
 ```json
 "team_gradeable": {
     "team_size_max": 3,
-    "inherit_from": "gradeable_id",
+    "inherit_from": "gradeable_id"
 }
 ```
 #### Grade inquiries
 ```json
-"grading_inquiry": {
-  "grade_inquiry_per_component_allowed": false,
+"grading_inquiries": false,
+"grade_inquiries_per_component": false,
+```
+### Dates
+All dates should be formatted as "yyyy-m-dd hh:ii:ss". 
+
+Four digit year, one or two digit month, two digit day, two digit hour, minute, and second. 
+
+* ta_view_start_date -- The date and time that the TA can view the gradeable
+* submission_open_date -- The date and time that submissions open
+* submission_due_date -- The date and time that submissions are due
+* grade_start_date -- The date that TAs can start grading
+* grade_due_date -- The date that TAs grades are due
+* team_lock_date -- The date that students can no longer join/change teams
+* grade_released_date -- The date that grades are released to students (only applicable if has_release_date is true)
+* grade_inquiry_start_date -- The date that grade inquiries can start to be submitted if grade inquiries are allowed
+* grade_inquiry_due_date -- The final day for grade inquiries if they are allowed.
+* has_due_date -- (true/false) If the gradeable has a due date,
+* has_release_date -- (true/false) If the gradeable has a grade_released_date
+* late_days_allowed -- (true/false) If students are allowed to use late days on the assignment
+* late_days -- The amount of late days students can use on the assignment
+```json
+"dates": {
+    "ta_view_start_date": "2024-1-10 23:59:59.00",
+    "submission_open_date": "2024-1-10 23:59:59.00",
+    "submission_due_date": "2024-2-10 23:59:59.00",
+    "grade_start_date": "2024-2-10 23:59:59.00",
+    "grade_due_date": "2024-3-10 23:59:59.00",
+    "team_lock_date": "2024-1-10 23:59:59.00",
+    "grade_released_date": "2024-3-10 23:59:59.00",
+    "grade_inquiry_start_date": "2024-3-10 23:59:59.00",
+    "grade_inquiry_due_date": "2024-3-10 23:59:59.00",
+    "has_due_date": false,
+    "has_release_date": false,
+    "late_days_allowed": false,
+    "late_days": 3
 }
 ```
+
 #### Other
 * ta_grading -- If the TA will grade any/all of the assignments (Default false)
 * discussion_thread_id -- The thread ID if using forums (Default none)
@@ -68,15 +103,29 @@ __Other Electronic Types__
   },
   "team_gradeable": {
     "team_size_max": 3,
-    "inherit_from": "gradeable_id",
+    "inherit_from": "gradeable_id"
   },
   "bulk_upload": false,
-  "grading_inquiry": {
-    "grade_inquiry_per_component_allowed": false
-  },
+  "grading_inquiries": false,
+  "grade_inquiry_per_component_allowed": false,
   "ta_grading": false,
   "discussion_thread_id": "thread_id",
-  "syllabus_bucket": "Homework"
+  "syllabus_bucket": "Homework",
+  "dates": {
+    "ta_view_start_date": "2024-1-10 23:59:59",
+    "submission_open_date": "2024-1-10 23:59:59",
+    "submission_due_date": "2024-2-10 23:59:59",
+    "grade_start_date": "2024-2-10 23:59:59",
+    "grade_due_date": "2024-3-10 23:59:59",
+    "team_lock_date": "2024-1-10 23:59:59",
+    "grade_released_date": "2024-3-10 23:59:59",
+    "grade_inquiry_start_date": "2024-3-10 23:59:59",
+    "grade_inquiry_due_date": "2024-3-10 23:59:59",
+    "has_due_date": false,
+    "has_release_date": false,
+    "late_days_allowed": false,
+    "late_days": 3
+  }
 }
 ```
 #### Sample Bulk Upload Template
@@ -111,3 +160,4 @@ __Other Electronic Types__
     "vcs_subdirectory": "subdirectory"
   },
 }
+```

_docs/instructor/autograding/docker_images.md

@@ -0,0 +1,83 @@
+---
+title: Custom Docker Imagegs
+category: Instructor > Autograding
+---
+
+Some assignments may require specific languages, packages, libraries, etc.
+We can't install all of these different requirements on the base system.
+We offer the ability to use custom Docker images for autograding.
+We pull images from Dockerhub and allow you to run any command inside
+that container. Below are steps to make your own or edit an image:
+
+1. Create a Dockerfile or fetch an existing one
+
+    If this is a new Dockerfile, choose a base image.
+    We recommend you choose the same base image as your system OS (i.e. ubuntu:22.04)
+    but you could, in theory, pick any base image you want.
+
+2. Add any packages, libraries, languages, etc that you need
+
+3. Build your image locally
+
+    Run the following in the directory containing the Dockerfile.
+    Replace `NAME` with a tag name you would like for your Docker image.
+    ```
+    docker build -t NAME .
+    ```
+
+4. Test your image locally
+
+    Run the following to enter a bash shell inside your container:
+    ```
+    docker run --rm -it NAME bash
+    ```
+
+    Verify that you can call any specific commands you want to on Submitty.
+
+5. Push your tag to Dockerhub
+
+    First you need to tag your image in the proper format for Dockerhub.
+    An example would be `submitty/autograding-default:latest`.
+    ```
+    docker image tag NAME USERNAME/REPONAME:TAGNAME
+    ```
+
+    Next you need to push it to Dockerhub. If you have not logged into Docker on your CLI then run:
+    ```
+    docker login
+    ```
+
+    Finally, push the image:
+    ```
+    docker push USERNAME/REPONAME:TAGNAME
+    ```
+
+    _NOTE: At RPI, we maintain a [GitHub repo](https://github.com/Submitty/DockerImagesRPI)
+    to automate this process when Dockerfiles are updated in the correct location in the repo._
+
+6. Add the Docker image to Submitty via the Docker UI
+
+    Click [here](/instructor/autograding/docker_ui) to learn more about how to do this.
+
+7. In your autograding `config.json`, specify this new image.
+
+    In the root level of your JSON object, add:
+    ```
+    "autograding_method": "docker",
+    ```
+
+    You also need to choose your specific image which there are 2 ways to do this.
+
+    You can specify an image at the root level which will apply to all test cases.
+    Add the following to the root level of your JSON object:
+    ```
+    "container_options": {
+        "container_image": "IMAGE_NAME"
+    },
+    ```
+    Replace `IMAGE_NAME` with your full image tag you added to the Docker UI.
+    Once this is complete, you can specify the command you want to be run.
+
+    Another way this can be done is by specifying the image at each test case.
+    See [Networked Containers](/instructor/autograding/networking) for more on this.
+

_docs/sysadmin/configuration/registration_feed.md

@@ -95,7 +95,7 @@ The columns/fields may be in any order.
 
 
 ### 4. Install On Ubuntu Server
-As these are PHP scripts, they _should_ run on any computer that has PHP 7.3 or 7.4 and the appropriate extensions installed.
+As these are PHP scripts, they _should_ run on any computer that has a version of PHP 7.3 through 8.3, and the appropriate extensions installed.
 However, these instructions will focus on Ubuntu server 20.04 which provides PHP 7.4 by default.
 
 1. If they haven't already been installed, install PHP and the required extensions.
@@ -364,14 +364,6 @@ Rows that do not match this constant's  value will be ignored and a warning adde
 It is possible that when one row does not match, all rows will not match.
 
 
-#### End of Line Detection
-```php
-ini_set('auto_detect_line_endings', true);
-```
-This shouldn't be changed.
-It ensures that CSV files exported by Microsoft Excel for Macintosh are correctly processed.
-
-
 #### Timezone
 ```php
 date_default_timezone_set('America/New_York');
@@ -401,8 +393,8 @@ These optional scripts can assist in retrieving CSV data, as opposed to the data
 #### `csv_local.php`
 Should CSV data files be made available in the local or a mounted filesystem, this script will help you validate and retrieve the CSV data file for the auto feed.  Validation includes file's existence and that the timestamp is current, so to not reprocess an old CSV file.
 
-**`config.php`**
-*Define* |
+##### `config.php`
+*define* |
 `'LOCAL_SOURCE_CSV'` | Path/file to retrieve and placed in the location of [`'CSV_FILE'`](#csv-file-access) so that it may be processed.
 
 
@@ -411,7 +403,7 @@ This script will retrieve CSV Data files attached to an email in an IMAP email a
 
 ***IMPORTANT:*** This script is highly specialized, and is currently obsolete and unsupported.  This script is provided "as is" as a sample for another developer to adapt for their University's needs.  Use at your own risk.
 
-**config.php**
+##### `config.php`
 *define* |
 `'IMAP_HOSTNAME'` | FQDN of the IMAP email service.
 `'IMAP_PORT'` | Network port to access IMAP email.
@@ -438,7 +430,7 @@ This script attempts to open an SSH connection to another server, locate and rea
 
 ***IMPORTANT:*** This script is highly specialized, and is currently obsolete and unsupported.  This script is provided "as is" as a sample for another developer to adapt for their University's needs.  Use at your own risk.
 
-**config.php**
+##### `config.php`
 *define* |
 `'JSON_REMOTE_HOSTNAME'` | FQDN of the host server to access for the JSON file.
 `'JSON_REMOTE_PORT'` | Network port for SSH access.  Usually 22.