Skip to content

Commit e18f63f

Browse files
authored
[Documentation:Developer] Reorganize troubleshooting (#565)
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>
1 parent 2e9fcf4 commit e18f63f

File tree

14 files changed

+261
-256
lines changed

14 files changed

+261
-256
lines changed

.bundle/config

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
---
22
BUNDLE_PATH: "vendor/bundle"
3+
BUNDLE_FROZEN: "false"

Gemfile.lock

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,46 @@
11
GEM
22
remote: https://rubygems.org/
33
specs:
4-
activesupport (7.0.7)
4+
activesupport (7.1.2)
5+
base64
6+
bigdecimal
57
concurrent-ruby (~> 1.0, >= 1.0.2)
8+
connection_pool (>= 2.2.5)
9+
drb
610
i18n (>= 1.6, < 2)
711
minitest (>= 5.1)
12+
mutex_m
813
tzinfo (~> 2.0)
9-
addressable (2.8.1)
14+
addressable (2.8.6)
1015
public_suffix (>= 2.0.2, < 6.0)
16+
base64 (0.2.0)
17+
bigdecimal (3.1.4)
1118
coffee-script (2.4.1)
1219
coffee-script-source
1320
execjs
1421
coffee-script-source (1.11.1)
1522
colorator (1.1.0)
16-
commonmarker (0.23.8)
23+
commonmarker (0.23.10)
1724
concurrent-ruby (1.2.2)
18-
dnsruby (1.61.9)
19-
simpleidn (~> 0.1)
25+
connection_pool (2.4.1)
26+
dnsruby (1.70.0)
27+
simpleidn (~> 0.2.1)
28+
drb (2.2.0)
29+
ruby2_keywords
2030
em-websocket (0.5.3)
2131
eventmachine (>= 0.12.9)
2232
http_parser.rb (~> 0)
2333
ethon (0.16.0)
2434
ffi (>= 1.15.0)
2535
eventmachine (1.2.7)
26-
eventmachine (1.2.7-x64-mingw32)
27-
execjs (2.8.1)
28-
faraday (2.7.4)
36+
execjs (2.9.1)
37+
faraday (2.7.12)
38+
base64
2939
faraday-net_http (>= 2.0, < 3.1)
3040
ruby2_keywords (>= 0.0.4)
3141
faraday-net_http (3.0.2)
32-
ffi (1.15.5)
33-
ffi (1.15.5-x64-mingw32)
42+
ffi (1.16.3)
43+
ffi (1.16.3-x64-mingw-ucrt)
3444
forwardable-extended (2.6.0)
3545
gemoji (3.0.1)
3646
github-pages (228)
@@ -215,30 +225,31 @@ GEM
215225
rb-fsevent (~> 0.10, >= 0.10.3)
216226
rb-inotify (~> 0.9, >= 0.9.10)
217227
mercenary (0.3.6)
218-
mini_portile2 (2.8.1)
219228
minima (2.5.1)
220229
jekyll (>= 3.5, < 5.0)
221230
jekyll-feed (~> 0.9)
222231
jekyll-seo-tag (~> 2.1)
223-
minitest (5.19.0)
224-
nokogiri (1.14.1)
225-
mini_portile2 (~> 2.8.0)
232+
minitest (5.20.0)
233+
mutex_m (0.2.0)
234+
nokogiri (1.15.5-arm64-darwin)
226235
racc (~> 1.4)
227-
nokogiri (1.14.1-x64-mingw32)
236+
nokogiri (1.15.5-x64-mingw-ucrt)
237+
racc (~> 1.4)
238+
nokogiri (1.15.5-x86_64-linux)
228239
racc (~> 1.4)
229240
octokit (4.25.1)
230241
faraday (>= 1, < 3)
231242
sawyer (~> 0.9)
232-
parallel (1.22.1)
243+
parallel (1.23.0)
233244
pathutil (0.16.2)
234245
forwardable-extended (~> 2.6)
235246
public_suffix (4.0.7)
236-
racc (1.6.2)
247+
racc (1.7.3)
237248
rainbow (3.1.1)
238249
rb-fsevent (0.11.2)
239250
rb-inotify (0.10.1)
240251
ffi (~> 1.0)
241-
rexml (3.2.5)
252+
rexml (3.2.6)
242253
rouge (3.26.0)
243254
ruby2_keywords (0.0.5)
244255
rubyzip (2.3.2)
@@ -255,26 +266,27 @@ GEM
255266
unf (~> 0.1.4)
256267
terminal-table (1.8.0)
257268
unicode-display_width (~> 1.1, >= 1.1.1)
258-
typhoeus (1.4.0)
269+
typhoeus (1.4.1)
259270
ethon (>= 0.9.0)
260271
tzinfo (2.0.6)
261272
concurrent-ruby (~> 1.0)
262273
unf (0.1.4)
263274
unf_ext
264-
unf_ext (0.0.8.2)
265-
unf_ext (0.0.8.2-x64-mingw32)
275+
unf_ext (0.0.9.1)
276+
unf_ext (0.0.9.1-x64-mingw-ucrt)
266277
unicode-display_width (1.8.0)
267278
webrick (1.8.1)
268279
yell (2.2.2)
269280

270281
PLATFORMS
271-
ruby
272-
x64-mingw32
282+
arm64-darwin-20
283+
x64-mingw-ucrt
284+
x86_64-linux
273285

274286
DEPENDENCIES
275287
github-pages (= 228)
276288
html-proofer (~> 3.19.4)
277289
webrick (~> 1.8)
278290

279291
BUNDLED WITH
280-
2.2.24
292+
2.4.21

_docs/developer/development_instructions/index.md

Lines changed: 3 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ complicated and expensive steps at the bottom of the page._
2828

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

31-
3231
---
3332

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

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

205-
---
206-
207-
## System Clock Testing & Troubleshooting
208-
209-
* If the VM has a clock skew (incorrect time)
210-
211-
```
212-
sudo service ntp stop
213-
sudo ntpd -gq
214-
sudo service ntp start
215-
```
216-
217-
218-
* If you need to test time and/or date dependent elements, you can
219-
change it in the vagrant machine so you don't have to wait. To
220-
remove the syncing and set your own time:
221-
222-
```
223-
sudo systemctl disable ntp
224-
timedatectl set-ntp 0
225-
sudo date -s "<year>-<month>-<day> <hour>:<minute>:<seconds>
226-
```
227-
228-
To check the date, helpful to make sure the date and time you set has stuck:
229-
230-
```
231-
date
232-
```
233-
234-
To sync back with the current time:
235-
236-
```
237-
sudo systemctl enable ntp
238-
timedatectl set-ntp 1
239-
```
240204

241205
---
242206

@@ -259,12 +223,10 @@ these changes.
259223
```
260224
sudo python3 /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/update_database.py
261225
```
262-
263-
226+
264227
---
265228

266229
## Re-Creating All Sample Course Data
267-
268230
* If you've changed the script to create a new course
269231
(`create_course.sh`), or the schema for the master database
270232
(`submitty_db.sql`), or the schema for the course databases
@@ -331,6 +293,8 @@ these changes.
331293
work that has been done._
332294

333295
---
296+
---
297+
334298

335299
## Virtual Machine Recovery using Snapshots
336300

_docs/developer/development_instructions/sample_data.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,3 @@ You may also need to edit test cases in Cypress, Selenium, etc.
7373
---
7474

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

_docs/developer/development_instructions/troubleshooting.md

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

0 commit comments

Comments
 (0)