Skip to content

Commit 601fb9d

Browse files
committed
Fix PR
1 parent a000a39 commit 601fb9d

File tree

3 files changed

+93
-98
lines changed

3 files changed

+93
-98
lines changed

_docs/developer/development_instructions/index.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,98 @@ autograding configuration, you'll probably need to:
203203

204204
* [Batch Regrade Homeworks](/instructor/batch_regrade_submissions) already submitted to those gradeables.
205205

206+
207+
---
208+
209+
## System Re-Configuration
210+
211+
If recent development changes include modifications to files affecting
212+
the system installation process (e.g., changes to
213+
`CONFIGURE_SUBMITTY.py`, `install_system.sh`, `Vagrantfile`), you will
214+
need to either re-provision or re-build your VM from scratch to test
215+
these changes.
216+
217+
* To re-run the initial configuration step of Submitty, use this command:
218+
219+
```
220+
sudo python3 /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/CONFIGURE_SUBMITTY.py
221+
```
222+
223+
* To update existing databases:
224+
225+
```
226+
sudo python3 /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/update_database.py
227+
```
228+
229+
---
230+
231+
## Re-Creating All Sample Course Data
232+
* If you've changed the script to create a new course
233+
(`create_course.sh`), or the schema for the master database
234+
(`submitty_db.sql`), or the schema for the course databases
235+
(`course_tables.sql`), or you changed student/gradeable data
236+
we need to delete all courses and recreate
237+
the course databases, users, and sample submission uploads.
238+
239+
_NOTE: Make sure you are not be connected to any DBs (e.g., through
240+
pgAdmin) or else running the below scripts could put things into a
241+
broken state._
242+
243+
Run this command:
244+
245+
```
246+
sudo bash /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/bin/recreate_sample_courses.sh
247+
```
248+
249+
You can append the `--no_submissions` flag to the above command to
250+
skip creation of any sample submission data in the sample courses.
251+
This will accelerate the completion of this command, but you will be
252+
missing the hundreds of sample student submissions present in the
253+
full installation.
254+
255+
256+
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.
257+
258+
259+
See also: [Sample Course Data](/developer/development_instructions/sample_data)
260+
261+
---
262+
263+
## Complete System Re-Installation
264+
265+
* To re-provision your VM, exit the VM, and from a terminal your host
266+
machine within the Submitty GIT repository type:
267+
268+
```
269+
vagrant reload --provision
270+
```
271+
272+
Or if the VM is not already running:
273+
274+
```
275+
vagrant up --provision
276+
```
277+
278+
This is will be faster than doing a full `destroy`/`up`, however
279+
depending on the changes you've done to the VM, could leave it
280+
potentially unstable.
281+
282+
* Alternatively, re-build your VM from scratch:
283+
284+
```
285+
vagrant destroy
286+
vagrant up
287+
```
288+
289+
_NOTE: This process will take a bit of time (45 minutes or more),
290+
and requires an internet connection. It will delete any assignments
291+
you've uploaded to your VM installation. And it will erase any
292+
files you have created/edited within your VM that are not part of
293+
the shared directory of the Submitty working repository. It will
294+
also destroy the databases, and any grading configuration or grading
295+
work that has been done._
296+
297+
---
206298
---
207299

208300

_docs/developer/development_instructions/sample_data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ You may also need to edit test cases in Cypress, Selenium, etc.
7272

7373
---
7474

75-
See also: [Re-Creating All Sample Course Data](/developer/troubleshooting/reinstallation_troubleshooting)
75+
See also: [Re-Creating All Sample Course Data](/developer/development_instructions/index#re-creating-all-sample-course-data)

_docs/developer/troubleshooting/reinstallation_troubleshooting.md

Lines changed: 0 additions & 97 deletions
This file was deleted.

0 commit comments

Comments
 (0)