Skip to content

Commit a4060a3

Browse files
thegame615thegame615
authored
Merge branch 'main' into virtualizationsettings_called_svm
2 parents 96595dd + 1bd0f34 commit a4060a3

File tree

8 files changed

+168
-7
lines changed

8 files changed

+168
-7
lines changed

Diff for: ‎.github/workflows/test.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616

1717
- name: Get Ruby version
1818
id: rubyversion
19-
run: echo "::set-output name=version::$(curl https://raw.githubusercontent.com/github/pages-gem/master/.ruby-version)"
19+
run: echo "::set-output name=version::3.2"
2020

2121
- name: Set up Ruby
2222
uses: ruby/setup-ruby@v1

Diff for: ‎Gemfile

+2
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,5 @@ gem 'wdm', '>= 0.1.1' if Gem.win_platform?
1010
gem "webrick", "~> 1.8"
1111

1212
gem 'html-proofer', "~> 3.19.4"
13+
14+
gem 'json'

Diff for: ‎_docs/developer/getting_started/vm_install_using_vagrant.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -221,10 +221,23 @@ Below are quick steps to get everything installed and running.
221221
vagrant up
222222
```
223223
224-
Vagrant will build your VM. This will take maybe 30 minutes to a
225-
few hours depending on your Internet connection speed. When this
226-
command finishes, your VM is ready to use.
224+
If you are using VirtualBox as your provider, you will by default use
225+
a pre-packaged Submitty VM. This will have all of Submitty already setup.
226+
Vagrant will build your VM for you. This process will take 10 minutes to
227+
maybe half an hour depending on your internet connection speed.
228+
When this command finishes, your VM is ready to use.
227229
230+
If you wish to run `vagrant up` from scratch, on Linux or Mac type:
231+
```
232+
BASE_BOX=1 vagrant up
233+
```
234+
or on Windows, type:
235+
```
236+
SET BASE_BOX=1
237+
vagrant up
238+
```
239+
This process will take anywhere from 30 minutes to a few hours depending on your
240+
internet speed.
228241
229242
7. When the `vagrant up` command completes successfully, you will be
230243
able to access the Submitty website (instructions follow in the

Diff for: ‎_docs/instructor/assignment_preparation/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ redirect_from:
1010
### Create a New Gradeable
1111

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

1616
Most of the fields on the Create/Edit Gradeable form can be changed
1717
later. You can return to this form from the main page by pressing the

Diff for: ‎_docs/instructor/assignment_preparation/upload_gradeable.md

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
---
2+
category: Instructor > Assignment Preparation
3+
title: Upload Gradeable
4+
redirect_from:
5+
- /instructor/assignment_preparation/upload_gradeable
6+
---
7+
To create a gradeable by uploading a JSON file, click the "Upload Gradeable Json" file in the top right.
8+
9+
Upload and submit the JSON file to the popup window. If the JSON file contains all of the correct information, you will be
10+
redirected to the gradeable edit screen.
11+
## Variables
12+
#### __Required__
13+
* title -- Gradeable title
14+
* type -- "Checkpoints", "Numeric", or "Electronic File"
15+
* id -- Gradeable ID (Must be unique)
16+
17+
#### Electronic File
18+
__VCS__
19+
* repository_type -- "submitty-hosted", "submitty-hosted-url", "public-github", "self-hosted", "private-github" (Required)
20+
* vcs_path -- Path to VCS repositories (Can be URL, Required)
21+
* vcs_subdirectory -- Path to files within the repository (Optional, leave out if not using subdirectories)
22+
23+
```json
24+
"vcs": {
25+
"repository_type": "submitty-hosted",
26+
"vcs_path": "http://localhost:1511/path/to/repository",
27+
"vcs_subdirectory": "subdirectory"
28+
}
29+
```
30+
31+
__Other Electronic Types__
32+
* bulk_upload -- If the TA will bilk upload assignments online (Default false)
33+
* normal -- Do not include bulk_upload or vcs to have a normal student upload gradeable.
34+
35+
#### Other Variables
36+
37+
#### Team assignments
38+
* team_size_max: Maximum team size
39+
* inherit_from: Gradeable ID to inherit teams from (Default none)
40+
41+
```json
42+
"team_gradeable": {
43+
"team_size_max": 3,
44+
"inherit_from": "gradeable_id",
45+
}
46+
```
47+
#### Grade inquiries
48+
```json
49+
"grading_inquiry": {
50+
"grade_inquiry_per_component_allowed": false,
51+
}
52+
```
53+
#### Other
54+
* ta_grading -- If the TA will grade any/all of the assignments (Default false)
55+
* discussion_thread_id -- The thread ID if using forums (Default none)
56+
* syllabus_bucket -- (Default "Homework")
57+
#### All variables
58+
```json
59+
{
60+
"title": "Example Json",
61+
"instructions_url": "",
62+
"id": "hw-1",
63+
"type": "Electronic File",
64+
"vcs": {
65+
"repository_type": "submitty-hosted",
66+
"vcs_path": "http://localhost:1511/path/to/repository",
67+
"vcs_subdirectory": "subdirectory"
68+
},
69+
"team_gradeable": {
70+
"team_size_max": 3,
71+
"inherit_from": "gradeable_id",
72+
},
73+
"bulk_upload": false,
74+
"grading_inquiry": {
75+
"grade_inquiry_per_component_allowed": false
76+
},
77+
"ta_grading": false,
78+
"discussion_thread_id": "thread_id",
79+
"syllabus_bucket": "Homework"
80+
}
81+
```
82+
#### Sample Bulk Upload Template
83+
```json
84+
{
85+
"title": "Testing Json",
86+
"id": "hw-bulk-upload",
87+
"type": "Electronic File",
88+
"bulk_upload": true,
89+
"syllabus_bucket": "Homework"
90+
}
91+
```
92+
#### Sample Checkpoints Template
93+
```json
94+
{
95+
"title": "Checkpoints Gradeable",
96+
"id": "hw-checkpoints",
97+
"type": "Checkpoints",
98+
"syllabus_bucket": "Homework"
99+
}
100+
```
101+
#### Sample VCS Template
102+
```json
103+
{
104+
"title": "VCS Gradeable",
105+
"id": "hw-vcs",
106+
"type": "Electronic File",
107+
"syllabus_bucket": "Homework",
108+
"vcs": {
109+
"repository_type": "submitty-hosted",
110+
"vcs_path": "http://localhost:1511/path/to/repository",
111+
"vcs_subdirectory": "subdirectory"
112+
},
113+
}

Diff for: ‎_docs/sysadmin/configuration/registration_feed.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ This defines the constant `CSV_FILE` and sets its value to `/path/to/datafile.cs
153153
_Do not change the constant_.
154154
Only change the constant's value.
155155

156-
We would need to change the value to reflect where the student data CSV is located (did you [note this](/sysadmin/configuration/registration_feed#4-before-installing-auto-feed-script) back in chapter 3?).
156+
We would need to change the value to reflect where the student data CSV is located (did you [note this](/sysadmin/configuration/registration_feed#3-before-installing-auto-feed-script) back in chapter 3?).
157157
For example, if your data warehouse delivers the feed CSV to `/users/datawarehouse/enrollment.csv` -- then change the line to read:
158158
```php
159159
define('CSV_FILE', '/users/datawarehouse/enrollment.csv');

Diff for: ‎_docs/sysadmin/configuration/term_creation.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Term Creation
3+
category: System Administrator > Configuration & Administration
4+
redirect_from:
5+
- /sysadmin/course_creation
6+
---
7+
8+
9+
### Creating a term
10+
To create a term, you should use the script
11+
```
12+
/usr/local/submitty/sbin/create_term.sh
13+
```
14+
Follow these usage guidelines:
15+
```
16+
Usage: create_term.sh [-a|--amend] <term> '<name of term>' <start date> <end date>
17+
```
18+
19+
The term should be an abbreviated semester name like:
20+
```
21+
s24
22+
```
23+
While name of term would be a more descriptive name like "Spring 2024".
24+
25+
The start and end date must be formatted in mm/dd/yyyy format.
26+
27+
Use -a or --amend to amend an existing term.
28+
An example valid usage of this command would be:
29+
30+
```
31+
create_term.sh s24 'Spring 2024' 01/09/2024 05/01/2024
32+
```

Diff for: ‎navtreedata.js

+1
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ var NAVTREE =
164164
[ "System Customization", "/sysadmin/installation/system_customization", null ],
165165
] ],
166166
[ "Configuration & Administration", "/sysadmin/configuration/course_creation", [
167+
[ "Term Creation", "/sysadmin/configuration/term_creation", null ],
167168
[ "Course Creation", "/sysadmin/configuration/course_creation", null ],
168169
[ "Setting up Version Control", "/sysadmin/configuration/version_control", null ],
169170
[ "SAML Authentication", "/sysadmin/configuration/saml_authentication", null ],

0 commit comments

Comments
 (0)