Skip to content

Commit

Permalink
Fix PR
Browse files Browse the repository at this point in the history
  • Loading branch information
RitaLei123 committed Dec 12, 2023
1 parent a000a39 commit 601fb9d
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 98 deletions.
92 changes: 92 additions & 0 deletions _docs/developer/development_instructions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,98 @@ autograding configuration, you'll probably need to:

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


---

## System Re-Configuration

If recent development changes include modifications to files affecting
the system installation process (e.g., changes to
`CONFIGURE_SUBMITTY.py`, `install_system.sh`, `Vagrantfile`), you will
need to either re-provision or re-build your VM from scratch to test
these changes.

* To re-run the initial configuration step of Submitty, use this command:

```
sudo python3 /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/CONFIGURE_SUBMITTY.py
```

* To update existing databases:

```
sudo python3 /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/update_database.py
```

---

## Re-Creating All Sample Course Data
* If you've changed the script to create a new course
(`create_course.sh`), or the schema for the master database
(`submitty_db.sql`), or the schema for the course databases
(`course_tables.sql`), or you changed student/gradeable data
we need to delete all courses and recreate
the course databases, users, and sample submission uploads.

_NOTE: Make sure you are not be connected to any DBs (e.g., through
pgAdmin) or else running the below scripts could put things into a
broken state._

Run this command:

```
sudo bash /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/bin/recreate_sample_courses.sh
```

You can append the `--no_submissions` flag to the above command to
skip creation of any sample submission data in the sample courses.
This will accelerate the completion of this command, but you will be
missing the hundreds of sample student submissions present in the
full installation.


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.


See also: [Sample Course Data](/developer/development_instructions/sample_data)

---

## Complete System Re-Installation

* To re-provision your VM, exit the VM, and from a terminal your host
machine within the Submitty GIT repository type:

```
vagrant reload --provision
```

Or if the VM is not already running:

```
vagrant up --provision
```

This is will be faster than doing a full `destroy`/`up`, however
depending on the changes you've done to the VM, could leave it
potentially unstable.

* Alternatively, re-build your VM from scratch:

```
vagrant destroy
vagrant up
```

_NOTE: This process will take a bit of time (45 minutes or more),
and requires an internet connection. It will delete any assignments
you've uploaded to your VM installation. And it will erase any
files you have created/edited within your VM that are not part of
the shared directory of the Submitty working repository. It will
also destroy the databases, and any grading configuration or grading
work that has been done._

---
---


Expand Down
2 changes: 1 addition & 1 deletion _docs/developer/development_instructions/sample_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ You may also need to edit test cases in Cypress, Selenium, etc.

---

See also: [Re-Creating All Sample Course Data](/developer/troubleshooting/reinstallation_troubleshooting)
See also: [Re-Creating All Sample Course Data](/developer/development_instructions/index#re-creating-all-sample-course-data)
97 changes: 0 additions & 97 deletions _docs/developer/troubleshooting/reinstallation_troubleshooting.md

This file was deleted.

0 comments on commit 601fb9d

Please sign in to comment.