From 269363742435b2a8f194dd5d5c2f0b05ce071f71 Mon Sep 17 00:00:00 2001 From: Rita Lei Date: Tue, 7 Nov 2023 14:18:14 -0500 Subject: [PATCH 01/13] Developer Troubleshooting Reorganized --- .../development_instructions/index.md | 128 +------------ .../troubleshooting.md | 102 ----------- .../vm_install_using_vagrant.md | 82 +-------- .../vm_install_using_vagrant_apple_silicon.md | 4 +- .../installation_troubleshooting.md | 173 ++++++++++++++++++ .../reinstallation_troubleshooting.md | 97 ++++++++++ .../system_clock_testing_troubleshooting.md | 40 ++++ .../troubleshooting/troubleshooting.md | 18 ++ navtreedata.js | 6 +- 9 files changed, 336 insertions(+), 314 deletions(-) delete mode 100644 _docs/developer/development_instructions/troubleshooting.md create mode 100644 _docs/developer/troubleshooting/installation_troubleshooting.md create mode 100644 _docs/developer/troubleshooting/reinstallation_troubleshooting.md create mode 100644 _docs/developer/troubleshooting/system_clock_testing_troubleshooting.md create mode 100644 _docs/developer/troubleshooting/troubleshooting.md diff --git a/_docs/developer/development_instructions/index.md b/_docs/developer/development_instructions/index.md index aad612c5..f0a15d66 100644 --- a/_docs/developer/development_instructions/index.md +++ b/_docs/developer/development_instructions/index.md @@ -28,6 +28,7 @@ complicated and expensive steps at the bottom of the page._ Please also see [Installation Version Notes](/sysadmin/installation/version_notes) +Please also see [Re-Installation Troubleshooting](/developer/troubleshooting/reinstallation_troubleshooting) --- @@ -204,133 +205,6 @@ autograding configuration, you'll probably need to: --- -## 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 "-- :: - ``` - - 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 - -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._ - ---- ## Virtual Machine Recovery using Snapshots diff --git a/_docs/developer/development_instructions/troubleshooting.md b/_docs/developer/development_instructions/troubleshooting.md deleted file mode 100644 index 8b2c5e56..00000000 --- a/_docs/developer/development_instructions/troubleshooting.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: Troubleshooting -category: Developer > Development Instructions ---- - - ---- - - -## Forwarded Port Already in Use - -* If you see an error similar to: - - ``` - Vagrant cannot forward the specified ports on this VM, since they - would collide with some other application that is already listening - on these ports. The forwarded port to #### is already in use - on the host machine. - ``` - - This means that one or more of the ports requested by vagrant is already in - use by another application running on your computer. - - -* This may happen if you attempt to create multiple Submitty VMs -- - perhaps unintentionally! E.g., if you have multiple directories on - your computer each with a clone/copy of the Submitty repo. It is - necessary to run `vagrant destroy` in each of these - directories/repositories to clean up unwanted VMs. - - The following command can help locate misplaced repositories/VMs: - - ``` - vagrant global-status - ``` - -* If you might have old, forgotten VMs from previous OS versions - hanging around it can be helpful to completely delete the `.vagrant` - folder in your repository. Also check to see if you have multiple - clones or backups of the repository and thus multiple `.vagrant` - folders on your machine. - - -* You can scan to see what processes on your machine are using the - conflicting ports. Depending on your operating system, try these - commands: - - ``` - netstat -anvp tcp | awk 'NR<3 || /LISTEN/' - ``` - - ``` - lsof -i | grep LISTEN - ``` - - Then you can type `kill ` with the `` of the process (if - you confirm you don't need that process). If you don't recognize - the process using the port in question, search to figure out if you - can or should disable it. For example, on MacOS, the AirPlay - Receiver in Control Center is using port 7000, so you may choose to - turn that off. - - -* You can choose to override the default ports and use an alternate - port through an environment variable. The current variables are - `VM_PORT_SITE`, `VM_PORT_WS`, `VM_PORT_DB`, `VM_PORT_SAML`, and - `VM_PORT_SSH`. - - For example, if the conflicting port is the default site port (1511), - and you want to use port 1512 instead: - ``` - VM_PORT_SITE=1512 vagrant up - ``` - - You can alternatively create a `.env` file in the root of your project - with the text `VM_PORT_SITE=1512` (and any other variables separated by - newlines). Note that you will need to install the env plugin beforehand: - ``` - vagrant plugin install vagrant-env - ``` - ---- - - -## Host-Only / Static Networking - -If you are having trouble being able to view the Submitty webpage after a ```vagrant up``` you might need to -modify the interfaces in your VM. To fix this: - -As root modify ```/etc/network/interfaces``` and add: - -``` -# The host-only network interface -auto eth1 -iface eth1 inet static -address 192.168.56.101 -netmask 255.255.255.0 -network 192.168.56.0 -broadcast 192.168.56.255 -``` - -References and useful links: [https://gist.github.com/pjdietz/5768124](https://gist.github.com/pjdietz/5768124) and [http://christophermaier.name/2010/09/01/host-only-networking-with-virtualbox/](http://christophermaier.name/2010/09/01/host-only-networking-with-virtualbox/) diff --git a/_docs/developer/getting_started/vm_install_using_vagrant.md b/_docs/developer/getting_started/vm_install_using_vagrant.md index 3ada54c5..02872f53 100644 --- a/_docs/developer/getting_started/vm_install_using_vagrant.md +++ b/_docs/developer/getting_started/vm_install_using_vagrant.md @@ -258,9 +258,7 @@ Below are quick steps to get everything installed and running. If you do not see this message due to an error or the installation has frozen, check out: - * [Installation Troubleshooting](#installation-troubleshooting) - - * [Development Instructions Troubleshooting](/developer/development_instructions/troubleshooting) + * [Installation Troubleshooting](/developer/troubleshooting/installation_troubleshooting.md) --- @@ -402,84 +400,6 @@ Below are quick steps to get everything installed and running. ``` vagrant up ``` - ---- - -## Installation Troubleshooting - -* If your install becomes stuck on ``SSH auth method: private key`` for more than three minutes, - then what you can do is open Virtual Box, navigate to your VM, and click the green "Show" button. - Having the VM's terminal GUI open can seem to keep it awake for communication. While developing on Submitty, - this "Show" terminal option can sometimes lead to the VM being faster with loads, so it may be worth having the GUI - open even after your vagrant up. - -* If your install seems to randomly freeze during `vagrant up` -with no explanation, then there are a couple of things that may be going wrong: - - *Note: If this happens, it may be worth running a simple `vagrant destroy` before you try to `vagrant up` again. It is possible to repair, but it is usually more effort than it is worth.* - - * First, check to make sure you have a solid internet connection. - Even if the connection is fast, it may experience drop-outs every - once in a while, so it is highly recommended to install it with a wired - connection to the internet. - - * Secondly, check to make sure your computer is not going to - sleep, this can be changed in settings for some systems, or you - can install a program to keep it awake (for example, amphetamine on Mac). - -* If an error is thrown during `vagrant up`, you may need to - uninstall Virtual Box and all virtual machines by typing the - following commands: - - _CAUTION: This should only be done if you do not have any other virtual machines._ - - To remove Virtual Box type: - - ``` - sudo apt-get remove --purge virtualbox - ``` - To remove all virtual machines and configuration files type: - - ``` - sudo rm ~/"VirtualBox VMs" -Rf - sudo rm ~/.config/VirtualBox/ -Rf - ``` - This will delete all virtual machine settings. Then install - the latest version of Virtual Box and vagrant from the links given in step 3 (using Ubuntu Software). - -* If it has been a while since your last `vagrant destroy` and - `vagrant up` you may need to update/upgrade/reinstall the virtual - box, vagrant, and the installed boxes on your - system: - - For example, on Mac: - - ``` - brew reinstall --cask virtualbox - brew reinstall --cask vagrant - vagrant plugin update - vagrant box update - ``` - - If you continue to have errors on Mac with `vagrant up` after - reinstalling virtualbox and vagrant, check "System Preferences" -> - "Security & Privacy". You may need to approve/reapprove - "Allow apps download from". You may also need to restart your computer. - - Similar instructions for other OS. - -* If this error is thrown during `vagrant up` command: - ``` - ubuntu-26.84: E: Failed to fetch http://us.archive.ubuntu.com/ubuntu/pool/main/g/gcc-9gcc-9_9.4.0-1ubuntu1-20.84.1_amd64.deb Connection fail [IP: 189.211.241.193] - ``` - then you should use VPN to connect to the internet and then try `vagrant up`.This error usually occurs when you are outside the United States and the connection to the Ubuntu package repository is being blocked or restricted. - - __Note:__ The IP address provided in the error message may vary. - ProtonVPN, which provides free VPN service can be used. You can download from their official website at (https://protonvpn.com). You can also use other VPN services. - - -* See also [Development Instructions Troubleshooting](/developer/development_instructions/troubleshooting) - --- ## Testing with a remote device diff --git a/_docs/developer/getting_started/vm_install_using_vagrant_apple_silicon.md b/_docs/developer/getting_started/vm_install_using_vagrant_apple_silicon.md index 0c13d8e4..f0299683 100644 --- a/_docs/developer/getting_started/vm_install_using_vagrant_apple_silicon.md +++ b/_docs/developer/getting_started/vm_install_using_vagrant_apple_silicon.md @@ -171,9 +171,7 @@ the installation process. If you do not see this message due to an error or the installation has frozen, check out: - * [Installation Troubleshooting](/developer/getting_started/vm_install_using_vagrant#installation-troubleshooting) - - * [Development Instructions Troubleshooting](/developer/development_instructions/troubleshooting) + * [Installation Troubleshooting](/developer/troubleshooting/installation_troubleshooting.md) --- diff --git a/_docs/developer/troubleshooting/installation_troubleshooting.md b/_docs/developer/troubleshooting/installation_troubleshooting.md new file mode 100644 index 00000000..d70ebe73 --- /dev/null +++ b/_docs/developer/troubleshooting/installation_troubleshooting.md @@ -0,0 +1,173 @@ +--- +title: Installation Troubleshooting +category: Developer > Troubleshooting +--- + + +--- + +* If your install becomes stuck on ``SSH auth method: private key`` for more than three minutes, + then what you can do is open Virtual Box, navigate to your VM, and click the green "Show" button. + Having the VM's terminal GUI open can seem to keep it awake for communication. While developing on Submitty, + this "Show" terminal option can sometimes lead to the VM being faster with loads, so it may be worth having the GUI + open even after your vagrant up. + +* If your install seems to randomly freeze during `vagrant up` +with no explanation, then there are a couple of things that may be going wrong: + + *Note: If this happens, it may be worth running a simple `vagrant destroy` before you try to `vagrant up` again. It is possible to repair, but it is usually more effort than it is worth.* + + * First, check to make sure you have a solid internet connection. + Even if the connection is fast, it may experience drop-outs every + once in a while, so it is highly recommended to install it with a wired + connection to the internet. + + * Secondly, check to make sure your computer is not going to + sleep, this can be changed in settings for some systems, or you + can install a program to keep it awake (for example, amphetamine on Mac). + +* If an error is thrown during `vagrant up`, you may need to + uninstall Virtual Box and all virtual machines by typing the + following commands: + + _CAUTION: This should only be done if you do not have any other virtual machines._ + + To remove Virtual Box type: + + ``` + sudo apt-get remove --purge virtualbox + ``` + To remove all virtual machines and configuration files type: + + ``` + sudo rm ~/"VirtualBox VMs" -Rf + sudo rm ~/.config/VirtualBox/ -Rf + ``` + This will delete all virtual machine settings. Then install + the latest version of Virtual Box and vagrant from the links given in step 3 (using Ubuntu Software). + +* If it has been a while since your last `vagrant destroy` and + `vagrant up` you may need to update/upgrade/reinstall the virtual + box, vagrant, and the installed boxes on your + system: + + For example, on Mac: + + ``` + brew reinstall --cask virtualbox + brew reinstall --cask vagrant + vagrant plugin update + vagrant box update + ``` + + If you continue to have errors on Mac with `vagrant up` after + reinstalling virtualbox and vagrant, check "System Preferences" -> + "Security & Privacy". You may need to approve/reapprove + "Allow apps download from". You may also need to restart your computer. + + Similar instructions for other OS. + +* If this error is thrown during `vagrant up` command: + ``` + ubuntu-26.84: E: Failed to fetch http://us.archive.ubuntu.com/ubuntu/pool/main/g/gcc-9gcc-9_9.4.0-1ubuntu1-20.84.1_amd64.deb Connection fail [IP: 189.211.241.193] + ``` + then you should use VPN to connect to the internet and then try `vagrant up`.This error usually occurs when you are outside the United States and the connection to the Ubuntu package repository is being blocked or restricted. + + __Note:__ The IP address provided in the error message may vary. + ProtonVPN, which provides free VPN service can be used. You can download from their official website at (https://protonvpn.com). You can also use other VPN services. + +--- + +## Forwarded Port Already in Use + +* If you see an error similar to: + + ``` + Vagrant cannot forward the specified ports on this VM, since they + would collide with some other application that is already listening + on these ports. The forwarded port to #### is already in use + on the host machine. + ``` + + This means that one or more of the ports requested by vagrant is already in + use by another application running on your computer. + + +* This may happen if you attempt to create multiple Submitty VMs -- + perhaps unintentionally! E.g., if you have multiple directories on + your computer each with a clone/copy of the Submitty repo. It is + necessary to run `vagrant destroy` in each of these + directories/repositories to clean up unwanted VMs. + + The following command can help locate misplaced repositories/VMs: + + ``` + vagrant global-status + ``` + +* If you might have old, forgotten VMs from previous OS versions + hanging around it can be helpful to completely delete the `.vagrant` + folder in your repository. Also check to see if you have multiple + clones or backups of the repository and thus multiple `.vagrant` + folders on your machine. + + +* You can scan to see what processes on your machine are using the + conflicting ports. Depending on your operating system, try these + commands: + + ``` + netstat -anvp tcp | awk 'NR<3 || /LISTEN/' + ``` + + ``` + lsof -i | grep LISTEN + ``` + + Then you can type `kill ` with the `` of the process (if + you confirm you don't need that process). If you don't recognize + the process using the port in question, search to figure out if you + can or should disable it. For example, on MacOS, the AirPlay + Receiver in Control Center is using port 7000, so you may choose to + turn that off. + + +* You can choose to override the default ports and use an alternate + port through an environment variable. The current variables are + `VM_PORT_SITE`, `VM_PORT_WS`, `VM_PORT_DB`, `VM_PORT_SAML`, and + `VM_PORT_SSH`. + + For example, if the conflicting port is the default site port (1511), + and you want to use port 1512 instead: + ``` + VM_PORT_SITE=1512 vagrant up + ``` + + You can alternatively create a `.env` file in the root of your project + with the text `VM_PORT_SITE=1512` (and any other variables separated by + newlines). Note that you will need to install the env plugin beforehand: + ``` + vagrant plugin install vagrant-env + ``` + +--- + + +## Host-Only / Static Networking + +If you are having trouble being able to view the Submitty webpage after a ```vagrant up``` you might need to +modify the interfaces in your VM. To fix this: + +As root modify ```/etc/network/interfaces``` and add: + +``` +# The host-only network interface +auto eth1 +iface eth1 inet static +address 192.168.56.101 +netmask 255.255.255.0 +network 192.168.56.0 +broadcast 192.168.56.255 +``` + +References and useful links: [https://gist.github.com/pjdietz/5768124](https://gist.github.com/pjdietz/5768124) and [http://christophermaier.name/2010/09/01/host-only-networking-with-virtualbox/](http://christophermaier.name/2010/09/01/host-only-networking-with-virtualbox/) diff --git a/_docs/developer/troubleshooting/reinstallation_troubleshooting.md b/_docs/developer/troubleshooting/reinstallation_troubleshooting.md new file mode 100644 index 00000000..d44015fb --- /dev/null +++ b/_docs/developer/troubleshooting/reinstallation_troubleshooting.md @@ -0,0 +1,97 @@ +--- +title: Reinstallation Troubleshooting +category: Developer > Troubleshooting +--- + + +--- + +## 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._ + +--- \ No newline at end of file diff --git a/_docs/developer/troubleshooting/system_clock_testing_troubleshooting.md b/_docs/developer/troubleshooting/system_clock_testing_troubleshooting.md new file mode 100644 index 00000000..841b316d --- /dev/null +++ b/_docs/developer/troubleshooting/system_clock_testing_troubleshooting.md @@ -0,0 +1,40 @@ +--- +title: System Clock Testing & Troubleshooting +category: Developer > 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 "-- :: + ``` + + 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 + ``` + +--- \ No newline at end of file diff --git a/_docs/developer/troubleshooting/troubleshooting.md b/_docs/developer/troubleshooting/troubleshooting.md new file mode 100644 index 00000000..f9f60886 --- /dev/null +++ b/_docs/developer/troubleshooting/troubleshooting.md @@ -0,0 +1,18 @@ +--- +title: Troubleshooting +category: Developer > Troubleshooting +--- + +--- + +* [Installation](/developer/getting_started/vm_install_using_vagrant) + +* [Installation Troubleshooting](/developer/troubleshooting/installation_troubleshooting) + +* [Overview](/developer/development_instructions/index) + +* [Re-Installation Troubleshooting](/developer/troubleshooting/reinstallation_troubleshooting) + +* [System Clock Testing Troubleshooting](/developer/troubleshooting/system_clock_testing_troubleshooting) + +--- \ No newline at end of file diff --git a/navtreedata.js b/navtreedata.js index abd40508..b2dba178 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -215,7 +215,6 @@ var NAVTREE = [ "GitHub Actions", "/developer/testing/github_actions", null ] ] ], [ "Vagrant Email Configuration", "/developer/development_instructions/vagrant_email_configuration", null ], - [ "Troubleshooting", "/developer/development_instructions/troubleshooting", null ], [ "Miscellaneous", "/developer/development_instructions/miscellaneous", null ], [ "Advanced Development", "/developer/development_instructions/automated_grading", [ [ "Automated Grading", "/developer/development_instructions/automated_grading", null ], @@ -234,6 +233,11 @@ var NAVTREE = [ "Frontend JavaScript", "/developer/developing_the_php_site/javascript", null] ] ], ] ], + [ "Troubleshooting & Other Information", "/developer/troubleshooting/troubleshooting", [ + [ "Installation", "/developer/troubleshooting/installation_troubleshooting", null ], + [ "Re-Installation", "/developer/troubleshooting/reinstallation_troubleshooting", null ], + [ "System Clock Testing", "/developer/troubleshooting/system_clock_testing_troubleshooting", null ], + ] ], [ "Software and System Design", "/developer/software_and_system_design/interface_design_style_guide", [ [ "Interface Design", "/developer/software_and_system_design/interface_design_style_guide", null ], [ "Web Accessibility", "/developer/software_and_system_design/web_accessibility", null ], From 0160ff022879128e050ee478e35f959894860257 Mon Sep 17 00:00:00 2001 From: Rita Lei Date: Tue, 7 Nov 2023 17:30:50 -0500 Subject: [PATCH 02/13] Remove Index Page --- .../troubleshooting/troubleshooting.md | 18 ------------------ navtreedata.js | 2 +- 2 files changed, 1 insertion(+), 19 deletions(-) delete mode 100644 _docs/developer/troubleshooting/troubleshooting.md diff --git a/_docs/developer/troubleshooting/troubleshooting.md b/_docs/developer/troubleshooting/troubleshooting.md deleted file mode 100644 index f9f60886..00000000 --- a/_docs/developer/troubleshooting/troubleshooting.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Troubleshooting -category: Developer > Troubleshooting ---- - ---- - -* [Installation](/developer/getting_started/vm_install_using_vagrant) - -* [Installation Troubleshooting](/developer/troubleshooting/installation_troubleshooting) - -* [Overview](/developer/development_instructions/index) - -* [Re-Installation Troubleshooting](/developer/troubleshooting/reinstallation_troubleshooting) - -* [System Clock Testing Troubleshooting](/developer/troubleshooting/system_clock_testing_troubleshooting) - ---- \ No newline at end of file diff --git a/navtreedata.js b/navtreedata.js index b2dba178..a7933efb 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -233,7 +233,7 @@ var NAVTREE = [ "Frontend JavaScript", "/developer/developing_the_php_site/javascript", null] ] ], ] ], - [ "Troubleshooting & Other Information", "/developer/troubleshooting/troubleshooting", [ + [ "Troubleshooting & Other Information", "/developer/troubleshooting/installation_troubleshooting", [ [ "Installation", "/developer/troubleshooting/installation_troubleshooting", null ], [ "Re-Installation", "/developer/troubleshooting/reinstallation_troubleshooting", null ], [ "System Clock Testing", "/developer/troubleshooting/system_clock_testing_troubleshooting", null ], From c4c9ca5d348f67c06b15e950ae1b38d7d4676c99 Mon Sep 17 00:00:00 2001 From: Rita Lei Date: Sun, 12 Nov 2023 15:16:14 -0500 Subject: [PATCH 03/13] Fixing Typo --- _docs/developer/getting_started/vm_install_using_vagrant.md | 2 +- .../getting_started/vm_install_using_vagrant_apple_silicon.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_docs/developer/getting_started/vm_install_using_vagrant.md b/_docs/developer/getting_started/vm_install_using_vagrant.md index 02872f53..19a0bd54 100644 --- a/_docs/developer/getting_started/vm_install_using_vagrant.md +++ b/_docs/developer/getting_started/vm_install_using_vagrant.md @@ -258,7 +258,7 @@ Below are quick steps to get everything installed and running. If you do not see this message due to an error or the installation has frozen, check out: - * [Installation Troubleshooting](/developer/troubleshooting/installation_troubleshooting.md) + * [Installation Troubleshooting](/developer/troubleshooting/installation_troubleshooting) --- diff --git a/_docs/developer/getting_started/vm_install_using_vagrant_apple_silicon.md b/_docs/developer/getting_started/vm_install_using_vagrant_apple_silicon.md index f0299683..8aade5da 100644 --- a/_docs/developer/getting_started/vm_install_using_vagrant_apple_silicon.md +++ b/_docs/developer/getting_started/vm_install_using_vagrant_apple_silicon.md @@ -171,7 +171,7 @@ the installation process. If you do not see this message due to an error or the installation has frozen, check out: - * [Installation Troubleshooting](/developer/troubleshooting/installation_troubleshooting.md) + * [Installation Troubleshooting](/developer/troubleshooting/installation_troubleshooting) --- From 5a610dc96fccad961e9acc5701fdd24807e62f1c Mon Sep 17 00:00:00 2001 From: Rita Lei Date: Sun, 12 Nov 2023 15:21:41 -0500 Subject: [PATCH 04/13] Updating Path for Re Creating Sample Course Data --- _docs/developer/development_instructions/sample_data.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/_docs/developer/development_instructions/sample_data.md b/_docs/developer/development_instructions/sample_data.md index 5615d6aa..ac4dede7 100644 --- a/_docs/developer/development_instructions/sample_data.md +++ b/_docs/developer/development_instructions/sample_data.md @@ -72,5 +72,4 @@ 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) - +See also: [Re-Creating All Sample Course Data](/developer/troubleshooting/reinstallation_troubleshooting/index#re-creating-all-sample-course-data) From de7a495d00ef672a147ba699411d7a1a055fed11 Mon Sep 17 00:00:00 2001 From: Rita Lei Date: Sun, 12 Nov 2023 15:44:52 -0500 Subject: [PATCH 05/13] Fix Path --- _docs/developer/development_instructions/sample_data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/developer/development_instructions/sample_data.md b/_docs/developer/development_instructions/sample_data.md index ac4dede7..f7131853 100644 --- a/_docs/developer/development_instructions/sample_data.md +++ b/_docs/developer/development_instructions/sample_data.md @@ -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/index#re-creating-all-sample-course-data) +See also: [Re-Creating All Sample Course Data](/developer/troubleshooting/reinstallation_troubleshooting) From 601fb9d0c887ffa12a921c36ebd63bc4d9bdf403 Mon Sep 17 00:00:00 2001 From: Rita Lei Date: Tue, 12 Dec 2023 12:48:59 -0500 Subject: [PATCH 06/13] Fix PR --- .../development_instructions/index.md | 92 ++++++++++++++++++ .../development_instructions/sample_data.md | 2 +- .../reinstallation_troubleshooting.md | 97 ------------------- 3 files changed, 93 insertions(+), 98 deletions(-) delete mode 100644 _docs/developer/troubleshooting/reinstallation_troubleshooting.md diff --git a/_docs/developer/development_instructions/index.md b/_docs/developer/development_instructions/index.md index f0a15d66..dd802b56 100644 --- a/_docs/developer/development_instructions/index.md +++ b/_docs/developer/development_instructions/index.md @@ -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._ + +--- --- diff --git a/_docs/developer/development_instructions/sample_data.md b/_docs/developer/development_instructions/sample_data.md index f7131853..7c678926 100644 --- a/_docs/developer/development_instructions/sample_data.md +++ b/_docs/developer/development_instructions/sample_data.md @@ -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) diff --git a/_docs/developer/troubleshooting/reinstallation_troubleshooting.md b/_docs/developer/troubleshooting/reinstallation_troubleshooting.md deleted file mode 100644 index d44015fb..00000000 --- a/_docs/developer/troubleshooting/reinstallation_troubleshooting.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: Reinstallation Troubleshooting -category: Developer > Troubleshooting ---- - - ---- - -## 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._ - ---- \ No newline at end of file From a49fc87ee0abdbaa15400180d412fede1aa736f3 Mon Sep 17 00:00:00 2001 From: Rita Lei Date: Tue, 12 Dec 2023 12:58:24 -0500 Subject: [PATCH 07/13] Fix navtreedata.js --- Gemfile.lock | 7 ++----- navtreedata.js | 1 - 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 6b068262..f67898fb 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -23,14 +23,12 @@ GEM 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) 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) forwardable-extended (2.6.0) gemoji (3.0.1) github-pages (228) @@ -224,8 +222,6 @@ GEM nokogiri (1.14.1) mini_portile2 (~> 2.8.0) racc (~> 1.4) - nokogiri (1.14.1-x64-mingw32) - racc (~> 1.4) octokit (4.25.1) faraday (>= 1, < 3) sawyer (~> 0.9) @@ -262,8 +258,8 @@ GEM unf (0.1.4) unf_ext unf_ext (0.0.8.2) - unf_ext (0.0.8.2-x64-mingw32) unicode-display_width (1.8.0) + wdm (0.1.1) webrick (1.8.1) yell (2.2.2) @@ -274,6 +270,7 @@ PLATFORMS DEPENDENCIES github-pages (= 228) html-proofer (~> 3.19.4) + wdm (>= 0.1.1) webrick (~> 1.8) BUNDLED WITH diff --git a/navtreedata.js b/navtreedata.js index a7933efb..f0c6785e 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -235,7 +235,6 @@ var NAVTREE = ] ], [ "Troubleshooting & Other Information", "/developer/troubleshooting/installation_troubleshooting", [ [ "Installation", "/developer/troubleshooting/installation_troubleshooting", null ], - [ "Re-Installation", "/developer/troubleshooting/reinstallation_troubleshooting", null ], [ "System Clock Testing", "/developer/troubleshooting/system_clock_testing_troubleshooting", null ], ] ], [ "Software and System Design", "/developer/software_and_system_design/interface_design_style_guide", [ From 7fa95348b3aa0340f39d2821e8d0c035c60097e7 Mon Sep 17 00:00:00 2001 From: Rita Lei Date: Tue, 12 Dec 2023 13:04:23 -0500 Subject: [PATCH 08/13] Remove reinstallation_troubleshooting instances --- _docs/developer/development_instructions/index.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/_docs/developer/development_instructions/index.md b/_docs/developer/development_instructions/index.md index dd802b56..648356f7 100644 --- a/_docs/developer/development_instructions/index.md +++ b/_docs/developer/development_instructions/index.md @@ -28,8 +28,6 @@ complicated and expensive steps at the bottom of the page._ Please also see [Installation Version Notes](/sysadmin/installation/version_notes) -Please also see [Re-Installation Troubleshooting](/developer/troubleshooting/reinstallation_troubleshooting) - --- ## Submitty Help - List of Shortcuts From 623cad3f904c313c687bf472854ea03e7c5f0482 Mon Sep 17 00:00:00 2001 From: Rita Lei Date: Tue, 12 Dec 2023 13:09:06 -0500 Subject: [PATCH 09/13] fix gem file --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index f67898fb..e8aed4f6 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -259,7 +259,7 @@ GEM unf_ext unf_ext (0.0.8.2) unicode-display_width (1.8.0) - wdm (0.1.1) + wdm (>= 0.1.1) webrick (1.8.1) yell (2.2.2) From b98d25282c85d7e45d771fbe499a1e38b6695fb5 Mon Sep 17 00:00:00 2001 From: Rita Lei Date: Tue, 12 Dec 2023 13:15:41 -0500 Subject: [PATCH 10/13] Gemfile fix --- Gemfile.lock | 51 ++++++++++++++++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 21 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index e8aed4f6..b21a0c2d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,34 +1,45 @@ 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) - 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.16.3-x64-mingw-ucrt) forwardable-extended (2.6.0) gemoji (3.0.1) github-pages (228) @@ -213,28 +224,27 @@ 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-x64-mingw-ucrt) 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) @@ -251,21 +261,20 @@ 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.9.1-x64-mingw-ucrt) unicode-display_width (1.8.0) - wdm (>= 0.1.1) + wdm (0.1.1) webrick (1.8.1) yell (2.2.2) PLATFORMS - ruby - x64-mingw32 + x64-mingw-ucrt DEPENDENCIES github-pages (= 228) @@ -274,4 +283,4 @@ DEPENDENCIES webrick (~> 1.8) BUNDLED WITH - 2.2.24 + 2.4.21 From 608d394e678783a44d6c7c5da5938afb568a63f6 Mon Sep 17 00:00:00 2001 From: Rita Lei Date: Tue, 12 Dec 2023 13:17:18 -0500 Subject: [PATCH 11/13] lockfile --- Gemfile.lock | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Gemfile.lock b/Gemfile.lock index b21a0c2d..0de99c4d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -39,6 +39,7 @@ GEM faraday-net_http (>= 2.0, < 3.1) ruby2_keywords (>= 0.0.4) faraday-net_http (3.0.2) + ffi (1.16.3) ffi (1.16.3-x64-mingw-ucrt) forwardable-extended (2.6.0) gemoji (3.0.1) @@ -232,6 +233,8 @@ GEM mutex_m (0.2.0) 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) @@ -267,6 +270,7 @@ GEM concurrent-ruby (~> 1.0) unf (0.1.4) unf_ext + unf_ext (0.0.9.1) unf_ext (0.0.9.1-x64-mingw-ucrt) unicode-display_width (1.8.0) wdm (0.1.1) @@ -275,6 +279,7 @@ GEM PLATFORMS x64-mingw-ucrt + x86_64-linux DEPENDENCIES github-pages (= 228) From 2a13d61e0c96ef329187744806504e2913431d9a Mon Sep 17 00:00:00 2001 From: Rita Lei Date: Tue, 12 Dec 2023 13:19:32 -0500 Subject: [PATCH 12/13] Ruby --- .bundle/config | 1 + 1 file changed, 1 insertion(+) diff --git a/.bundle/config b/.bundle/config index 23692288..ee5bb423 100644 --- a/.bundle/config +++ b/.bundle/config @@ -1,2 +1,3 @@ --- BUNDLE_PATH: "vendor/bundle" +BUNDLE_FROZEN: "false" From 535b58c2ab6def5920f703d0f43b1e2d70307ae0 Mon Sep 17 00:00:00 2001 From: Barb Cutler Date: Tue, 12 Dec 2023 16:05:37 -0500 Subject: [PATCH 13/13] minor edits --- Gemfile.lock | 5 +++-- .../troubleshooting/installation_troubleshooting.md | 4 +--- .../system_clock_testing_troubleshooting.md | 3 +-- _docs/sysadmin/troubleshooting/database_overview.md | 2 +- _docs/sysadmin/troubleshooting/log_files.md | 2 +- _docs/sysadmin/troubleshooting/system_debugging.md | 2 +- _docs/sysadmin/troubleshooting/user_access_level.md | 2 +- navtreedata.js | 8 ++++---- 8 files changed, 13 insertions(+), 15 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 0de99c4d..ad1ad4af 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -231,6 +231,8 @@ GEM jekyll-seo-tag (~> 2.1) minitest (5.20.0) mutex_m (0.2.0) + nokogiri (1.15.5-arm64-darwin) + racc (~> 1.4) nokogiri (1.15.5-x64-mingw-ucrt) racc (~> 1.4) nokogiri (1.15.5-x86_64-linux) @@ -273,18 +275,17 @@ GEM unf_ext (0.0.9.1) unf_ext (0.0.9.1-x64-mingw-ucrt) unicode-display_width (1.8.0) - wdm (0.1.1) webrick (1.8.1) yell (2.2.2) PLATFORMS + arm64-darwin-20 x64-mingw-ucrt x86_64-linux DEPENDENCIES github-pages (= 228) html-proofer (~> 3.19.4) - wdm (>= 0.1.1) webrick (~> 1.8) BUNDLED WITH diff --git a/_docs/developer/troubleshooting/installation_troubleshooting.md b/_docs/developer/troubleshooting/installation_troubleshooting.md index d70ebe73..226de852 100644 --- a/_docs/developer/troubleshooting/installation_troubleshooting.md +++ b/_docs/developer/troubleshooting/installation_troubleshooting.md @@ -1,11 +1,9 @@ --- title: Installation Troubleshooting -category: Developer > Troubleshooting +category: Developer > Development Troubleshooting --- ---- - * If your install becomes stuck on ``SSH auth method: private key`` for more than three minutes, then what you can do is open Virtual Box, navigate to your VM, and click the green "Show" button. Having the VM's terminal GUI open can seem to keep it awake for communication. While developing on Submitty, diff --git a/_docs/developer/troubleshooting/system_clock_testing_troubleshooting.md b/_docs/developer/troubleshooting/system_clock_testing_troubleshooting.md index 841b316d..dc956101 100644 --- a/_docs/developer/troubleshooting/system_clock_testing_troubleshooting.md +++ b/_docs/developer/troubleshooting/system_clock_testing_troubleshooting.md @@ -1,9 +1,8 @@ --- title: System Clock Testing & Troubleshooting -category: Developer > Troubleshooting +category: Developer > Development Troubleshooting --- ---- * If the VM has a clock skew (incorrect time) diff --git a/_docs/sysadmin/troubleshooting/database_overview.md b/_docs/sysadmin/troubleshooting/database_overview.md index d503febd..5fc50e3e 100644 --- a/_docs/sysadmin/troubleshooting/database_overview.md +++ b/_docs/sysadmin/troubleshooting/database_overview.md @@ -1,6 +1,6 @@ --- title: Database Overview -category: System Administrator > Troubleshooting & Other Information +category: System Administrator > SysAdmin Troubleshooting, etc. redirect_from: - /sysadmin/database_overview --- diff --git a/_docs/sysadmin/troubleshooting/log_files.md b/_docs/sysadmin/troubleshooting/log_files.md index 248b63aa..7ea5ff61 100644 --- a/_docs/sysadmin/troubleshooting/log_files.md +++ b/_docs/sysadmin/troubleshooting/log_files.md @@ -1,6 +1,6 @@ --- title: Log Files -category: System Administrator > Troubleshooting & Other Information +category: System Administrator > SysAdmin Troubleshooting, etc. redirect_from: - /instructor/log_files - /sysadmin/log_files diff --git a/_docs/sysadmin/troubleshooting/system_debugging.md b/_docs/sysadmin/troubleshooting/system_debugging.md index be6dfb3d..7a09ba28 100644 --- a/_docs/sysadmin/troubleshooting/system_debugging.md +++ b/_docs/sysadmin/troubleshooting/system_debugging.md @@ -1,6 +1,6 @@ --- title: Websockets / System & Debugging -category: System Administrator > Troubleshooting & Other Information +category: System Administrator > SysAdmin Troubleshooting, etc. redirect_from: - /sysadmin/system_debugging --- diff --git a/_docs/sysadmin/troubleshooting/user_access_level.md b/_docs/sysadmin/troubleshooting/user_access_level.md index a8df8301..35b0f2d8 100644 --- a/_docs/sysadmin/troubleshooting/user_access_level.md +++ b/_docs/sysadmin/troubleshooting/user_access_level.md @@ -1,6 +1,6 @@ --- title: User Access Level -category: System Administrator > Troubleshooting & Other Information +category: System Administrator > SysAdmin Troubleshooting, etc. redirect_from: - /sysadmin/user_access_level --- diff --git a/navtreedata.js b/navtreedata.js index f0c6785e..65345c19 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -172,7 +172,7 @@ var NAVTREE = [ "Rainbow Grades", "/sysadmin/configuration/rainbow_grades", null ], [ "Student Photos", "/sysadmin/configuration/student_photos", null ] ] ], - [ "Troubleshooting & Other Information", "/sysadmin/troubleshooting/database_overview", [ + [ "SysAdmin Troubleshooting, etc.", "/sysadmin/troubleshooting/database_overview", [ [ "Database Overview", "/sysadmin/troubleshooting/database_overview", null ], [ "User Access Level", "/sysadmin/troubleshooting/user_access_level", null ], [ "Log Files", "/sysadmin/troubleshooting/log_files", null ], @@ -233,9 +233,9 @@ var NAVTREE = [ "Frontend JavaScript", "/developer/developing_the_php_site/javascript", null] ] ], ] ], - [ "Troubleshooting & Other Information", "/developer/troubleshooting/installation_troubleshooting", [ - [ "Installation", "/developer/troubleshooting/installation_troubleshooting", null ], - [ "System Clock Testing", "/developer/troubleshooting/system_clock_testing_troubleshooting", null ], + [ "Development Troubleshooting", "/developer/troubleshooting/installation_troubleshooting", [ + [ "Installation Troubleshooting", "/developer/troubleshooting/installation_troubleshooting", null ], + [ "System Clock Troubleshooting", "/developer/troubleshooting/system_clock_testing_troubleshooting", null ], ] ], [ "Software and System Design", "/developer/software_and_system_design/interface_design_style_guide", [ [ "Interface Design", "/developer/software_and_system_design/interface_design_style_guide", null ],