Skip to content

Commit

Permalink
[Documentation:InstructorUI] Upload JSON to create gradeable (#576)
Browse files Browse the repository at this point in the history
This PR adds documentation on how to use the feature added in
Submitty/Submitty#10100.
  • Loading branch information
IDzyre authored Mar 1, 2024
1 parent cc10bca commit 2c3cb8b
Show file tree
Hide file tree
Showing 2 changed files with 115 additions and 2 deletions.
4 changes: 2 additions & 2 deletions _docs/instructor/assignment_preparation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ redirect_from:
### Create a New Gradeable

To create a new gradeable, instructor users should click "New
Gradeable" in the sidebar on the left of the screen.
Fill out this form (details in the following sections) and press "Create New Gradeable".
Gradeable" in the sidebar on the left of the screen. Either [Upload a JSON file](/instructor/assignment_preparation/upload_gradeable), or
fill out this form (details in the following sections) and press "Create New Gradeable".

Most of the fields on the Create/Edit Gradeable form can be changed
later. You can return to this form from the main page by pressing the
Expand Down
113 changes: 113 additions & 0 deletions _docs/instructor/assignment_preparation/upload_gradeable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
category: Instructor > Assignment Preparation
title: Upload Gradeable
redirect_from:
- /instructor/assignment_preparation/upload_gradeable
---
To create a gradeable by uploading a JSON file, click the "Upload Gradeable Json" file in the top right.

Upload and submit the JSON file to the popup window. If the JSON file contains all of the correct information, you will be
redirected to the gradeable edit screen.
## Variables
#### __Required__
* title -- Gradeable title
* type -- "Checkpoints", "Numeric", or "Electronic File"
* id -- Gradeable ID (Must be unique)

#### Electronic File
__VCS__
* repository_type -- "submitty-hosted", "submitty-hosted-url", "public-github", "self-hosted", "private-github" (Required)
* vcs_path -- Path to VCS repositories (Can be URL, Required)
* vcs_subdirectory -- Path to files within the repository (Optional, leave out if not using subdirectories)

```json
"vcs": {
"repository_type": "submitty-hosted",
"vcs_path": "http://localhost:1511/path/to/repository",
"vcs_subdirectory": "subdirectory"
}
```

__Other Electronic Types__
* bulk_upload -- If the TA will bilk upload assignments online (Default false)
* normal -- Do not include bulk_upload or vcs to have a normal student upload gradeable.

#### Other Variables

#### Team assignments
* team_size_max: Maximum team size
* inherit_from: Gradeable ID to inherit teams from (Default none)

```json
"team_gradeable": {
"team_size_max": 3,
"inherit_from": "gradeable_id",
}
```
#### Grade inquiries
```json
"grading_inquiry": {
"grade_inquiry_per_component_allowed": false,
}
```
#### 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)
* syllabus_bucket -- (Default "Homework")
#### All variables
```json
{
"title": "Example Json",
"instructions_url": "",
"id": "hw-1",
"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": {
"grade_inquiry_per_component_allowed": false
},
"ta_grading": false,
"discussion_thread_id": "thread_id",
"syllabus_bucket": "Homework"
}
```
#### Sample Bulk Upload Template
```json
{
"title": "Testing Json",
"id": "hw-bulk-upload",
"type": "Electronic File",
"bulk_upload": true,
"syllabus_bucket": "Homework"
}
```
#### Sample Checkpoints Template
```json
{
"title": "Checkpoints Gradeable",
"id": "hw-checkpoints",
"type": "Checkpoints",
"syllabus_bucket": "Homework"
}
```
#### Sample VCS Template
```json
{
"title": "VCS Gradeable",
"id": "hw-vcs",
"type": "Electronic File",
"syllabus_bucket": "Homework",
"vcs": {
"repository_type": "submitty-hosted",
"vcs_path": "http://localhost:1511/path/to/repository",
"vcs_subdirectory": "subdirectory"
},
}

0 comments on commit 2c3cb8b

Please sign in to comment.