Skip to content

Commit

Permalink
[Documentation:Developer] Reorganize troubleshooting (#565)
Browse files Browse the repository at this point in the history
Reorganized the troubleshooting pages under developer. Organized
troubleshooting into 3 files (Installation troubleshooting,
Re-installation troubleshooting, and System Clock Testing &
Troubleshooting). Now developers can go to the new troubleshooting
folder to find instructions on how to fix their problem.

<img width="960" alt="image"
src="https://github.com/Submitty/submitty.github.io/assets/117528498/3871cb3b-e700-4876-a0eb-c1ff30af12be">

---------

Co-authored-by: Barb Cutler <Barb Cutler>
  • Loading branch information
RitaLei123 authored Dec 12, 2023
1 parent 2e9fcf4 commit e18f63f
Show file tree
Hide file tree
Showing 14 changed files with 261 additions and 256 deletions.
1 change: 1 addition & 0 deletions .bundle/config
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
---
BUNDLE_PATH: "vendor/bundle"
BUNDLE_FROZEN: "false"
60 changes: 36 additions & 24 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,36 +1,46 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (7.0.7)
activesupport (7.1.2)
base64
bigdecimal
concurrent-ruby (~> 1.0, >= 1.0.2)
connection_pool (>= 2.2.5)
drb
i18n (>= 1.6, < 2)
minitest (>= 5.1)
mutex_m
tzinfo (~> 2.0)
addressable (2.8.1)
addressable (2.8.6)
public_suffix (>= 2.0.2, < 6.0)
base64 (0.2.0)
bigdecimal (3.1.4)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.11.1)
colorator (1.1.0)
commonmarker (0.23.8)
commonmarker (0.23.10)
concurrent-ruby (1.2.2)
dnsruby (1.61.9)
simpleidn (~> 0.1)
connection_pool (2.4.1)
dnsruby (1.70.0)
simpleidn (~> 0.2.1)
drb (2.2.0)
ruby2_keywords
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
ethon (0.16.0)
ffi (>= 1.15.0)
eventmachine (1.2.7)
eventmachine (1.2.7-x64-mingw32)
execjs (2.8.1)
faraday (2.7.4)
execjs (2.9.1)
faraday (2.7.12)
base64
faraday-net_http (>= 2.0, < 3.1)
ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.2)
ffi (1.15.5)
ffi (1.15.5-x64-mingw32)
ffi (1.16.3)
ffi (1.16.3-x64-mingw-ucrt)
forwardable-extended (2.6.0)
gemoji (3.0.1)
github-pages (228)
Expand Down Expand Up @@ -215,30 +225,31 @@ GEM
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.3.6)
mini_portile2 (2.8.1)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.19.0)
nokogiri (1.14.1)
mini_portile2 (~> 2.8.0)
minitest (5.20.0)
mutex_m (0.2.0)
nokogiri (1.15.5-arm64-darwin)
racc (~> 1.4)
nokogiri (1.14.1-x64-mingw32)
nokogiri (1.15.5-x64-mingw-ucrt)
racc (~> 1.4)
nokogiri (1.15.5-x86_64-linux)
racc (~> 1.4)
octokit (4.25.1)
faraday (>= 1, < 3)
sawyer (~> 0.9)
parallel (1.22.1)
parallel (1.23.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.7)
racc (1.6.2)
racc (1.7.3)
rainbow (3.1.1)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rexml (3.2.6)
rouge (3.26.0)
ruby2_keywords (0.0.5)
rubyzip (2.3.2)
Expand All @@ -255,26 +266,27 @@ GEM
unf (~> 0.1.4)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
typhoeus (1.4.0)
typhoeus (1.4.1)
ethon (>= 0.9.0)
tzinfo (2.0.6)
concurrent-ruby (~> 1.0)
unf (0.1.4)
unf_ext
unf_ext (0.0.8.2)
unf_ext (0.0.8.2-x64-mingw32)
unf_ext (0.0.9.1)
unf_ext (0.0.9.1-x64-mingw-ucrt)
unicode-display_width (1.8.0)
webrick (1.8.1)
yell (2.2.2)

PLATFORMS
ruby
x64-mingw32
arm64-darwin-20
x64-mingw-ucrt
x86_64-linux

DEPENDENCIES
github-pages (= 228)
html-proofer (~> 3.19.4)
webrick (~> 1.8)

BUNDLED WITH
2.2.24
2.4.21
42 changes: 3 additions & 39 deletions _docs/developer/development_instructions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ complicated and expensive steps at the bottom of the page._

Please also see [Installation Version Notes](/sysadmin/installation/version_notes)


---

## Submitty Help - List of Shortcuts
Expand Down Expand Up @@ -202,41 +201,6 @@ autograding configuration, you'll probably need to:

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

---

## System Clock Testing & Troubleshooting

* If the VM has a clock skew (incorrect time)

```
sudo service ntp stop
sudo ntpd -gq
sudo service ntp start
```


* If you need to test time and/or date dependent elements, you can
change it in the vagrant machine so you don't have to wait. To
remove the syncing and set your own time:

```
sudo systemctl disable ntp
timedatectl set-ntp 0
sudo date -s "<year>-<month>-<day> <hour>:<minute>:<seconds>
```

To check the date, helpful to make sure the date and time you set has stuck:

```
date
```

To sync back with the current time:

```
sudo systemctl enable ntp
timedatectl set-ntp 1
```

---

Expand All @@ -259,12 +223,10 @@ these changes.
```
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
Expand Down Expand Up @@ -331,6 +293,8 @@ these changes.
work that has been done._

---
---


## Virtual Machine Recovery using Snapshots

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

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

102 changes: 0 additions & 102 deletions _docs/developer/development_instructions/troubleshooting.md

This file was deleted.

Loading

0 comments on commit e18f63f

Please sign in to comment.