Merge branch 'main' of github.com:Submitty/submitty.github.io into sysadmin-note-http2

Author: Barb Cutler

.bundle/config

@@ -1,2 +1,3 @@
 ---
 BUNDLE_PATH: "vendor/bundle"
+BUNDLE_FROZEN: "false"

Gemfile.lock

@@ -1,36 +1,46 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.2)
+    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)
-    concurrent-ruby (1.2.0)
-    dnsruby (1.61.9)
-      simpleidn (~> 0.1)
+    commonmarker (0.23.10)
+    concurrent-ruby (1.2.2)
+    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)
@@ -96,7 +106,7 @@ GEM
       typhoeus (~> 1.3)
       yell (~> 2.0)
     http_parser.rb (0.8.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     jekyll (3.9.3)
       addressable (~> 2.4)
@@ -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.17.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)
@@ -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

README.md

@@ -41,8 +41,8 @@ by running:
    ```
 
    * _NOTE: During the install, it may hang up when installing the
-     dependency ``nokogiri``.  Don't worry: press enter and it should
-     continue.
+     dependency ``nokogiri``.  Don't worry: continue waiting. If it still is stalling
+     here, press enter and it should continue._
 
 
    * _NOTE: If an error is thrown during the installation process you

_docs/developer/development_instructions/index.md

@@ -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
@@ -55,8 +54,9 @@ Please also see [Installation Version Notes](/sysadmin/installation/version_note
 ## Website and Bin Script Changes
 
 * If you have only made minor or modest visual changes to website
-  (e.g., the html, css, twig, or php files), or other files in the
-  `site` folder, you can apply those changes by running this shortcut:
+  (e.g., the html, css, twig, or php files), other files in the `site`
+  folder, or translation files in the Localization repository, you can
+  apply those changes by running this shortcut:
 
   ```
   submitty_install_site
@@ -124,9 +124,7 @@ be able to reload the website and see the update.
   See also: [PhpStorm configuration instructions](/developer/getting_started/phpstorm)
 
 
----
-
-## Clearing Your Browser Cache
+### Clearing Your Browser Cache
 
 
 * If the JavaScript files have changed and there are errors or you do not see the
@@ -162,6 +160,9 @@ include more significant Submitty source code changes, it will likely
 be necessary to conduct a more complete update and reset re-set of all
 of the Submitty source code.
 
+
+
+
 * In these cases, run this shortcut in the vagrant terminal:
 
    ```
@@ -186,9 +187,12 @@ of the Submitty source code.
    sudo /usr/local/submitty/.setup/INSTALL_SUBMITTY.sh clean
    ```
 
----
 
-## Autograding Development
+Note: The above commands will also apply any necessary system and
+database [Migrations](/developer/development_instructions/migrations).
+
+
+### Autograding Development
 
 In addition to the `submitty_install` command above, if you modify an
 autograding configuration, you'll probably need to:
@@ -198,42 +202,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
-  ```
-
 ---
 
 ## System Re-Configuration
@@ -255,16 +223,15 @@ 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
-  (`course_tables.sql`), we need to delete all courses, and recreate
+  (`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
@@ -283,8 +250,11 @@ these changes.
   missing the hundreds of sample student submissions present in the
   full installation.
 
-  See also: [Database Migrations](/developer/development_instructions/migrations)
 
+  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)
 
 ---
 
@@ -322,3 +292,23 @@ these changes.
   also destroy the databases, and any grading configuration or grading
   work that has been done._
 
+---
+---
+
+
+## Virtual Machine Recovery using Snapshots
+
+In the event of a non-recoverable error while working on Submitty the last resort is to, perform a fresh `vagrant up`. However, this process can be time-consuming. To avoid such situations and save time, it is highly recommended to take a snapshot when you first set up your Vagrant environment by following the tutorial links provided below:
+
+* [Virtual Box](https://www.youtube.com/watch?v=Kl-Qc6N9znw)
+
+* [VMWare](https://www.youtube.com/watch?v=DQutP_-2j3g)
+
+* [Vagrant](https://developer.hashicorp.com/vagrant/docs/cli/snapshot)
+
+By taking a snapshot at this initial stage, you can later revert to this saved state if needed, ensuring a quick recovery. Once you have restored the snapshot, you can then proceed with the following steps:
+
+1. Launch the virtual machine using `vagrant up`.
+2. Access the virtual machine with `vagrant ssh`.
+3. Run `submitty_install` command to conduct a more complete update and reset of all of the Submitty source code.
+