From 822211dd818a55bd745b10fdf30969e2f1f5bb92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A1tvik=20Karanam?= <89281036+skara9@users.noreply.github.com> Date: Tue, 6 Aug 2024 15:08:34 -0400 Subject: [PATCH 1/6] small corrections --- .../vm_install_using_vagrant.md | 21 +++++++++---------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/_docs/developer/getting_started/vm_install_using_vagrant.md b/_docs/developer/getting_started/vm_install_using_vagrant.md index 3789f049..7aa6be5a 100644 --- a/_docs/developer/getting_started/vm_install_using_vagrant.md +++ b/_docs/developer/getting_started/vm_install_using_vagrant.md @@ -14,8 +14,7 @@ Unix/Linux). The installation process will create a new Virtual Machine (VM) on your computer and the VM will use the Ubuntu GNU/Linux operating system. -***NOTE:** We only officially support and test development using VirtualBox for AMD -and Intel machines and QEMU for M-Series ARM MacOS machines.* +***NOTE:** We only officially support and test development using VirtualBox for AMD and Intel machines and QEMU for M-Series ARM MacOS machines.* --- @@ -52,12 +51,12 @@ and Intel machines and QEMU for M-Series ARM MacOS machines.* 5. If you're on M-series ARM MacOS (e.g., M1, M2, M3), you will be using QEMU with SMB file sharing. To enable this, open **System Settings** and navigate to **General > Sharing**. - Press the (i) button next to **File Sharing**, and in the popup window - click "Options...". Then turn on "Share files and folders using SMB" and + Press the (i) button next to **File Sharing**, and in thse popup window + click "Options...". Then turn on "Share files and folder using SMB" and check the box next to your name in the list below. 6. The complete installation process could take an hour or more and - will quite possiby fail if paused or interrupted. Make + will quite possibly fail if paused or interrupted. Make sure your internet connection is strong and consistent. You'll probably want to plug in your laptop power cord. Check your computer settings and make sure the machine does not hibernate or @@ -255,7 +254,7 @@ and Intel machines and QEMU for M-Series ARM MacOS machines.* vagrant up --provider=virtualbox ``` - If you wish to use a specific version of the pre-packaged Submitty VM, on Linux type: + If you wish to use a specific version of the pre-packaged Submitty VM, on Linux/MacOS type: ``` PREBUILT_VERSION={version} vagrant up --provider=virtualbox ``` @@ -273,25 +272,25 @@ and Intel machines and QEMU for M-Series ARM MacOS machines.* ***Note:** The vagrant up command creates and provisions the virtual machine on the first run. - The `--provider` flag is important if you have more than one virtual box provider + The `--provider` flag is important if you have more than one provider installed on your machine (e.g., VirtualBox, VMWare, QEMU, libvirt). For subsequent runs, you do not need to append the `--provider` flag as the VM is already created.* - * **Build (from scratch) using QEMU on an M-Series Arm MacOKS** + * **Build (from scratch) using QEMU on an M-Series Arm MacOS** - If you have an M-series ARM MacOS, run: + If you have an M-series ARM Mac, run: ``` vagrant up --provider=qemu ``` - *As noted above, the `--provider` flag is only necessary on the first run when the VM is created.* + *As noted above, you do not need to append the `--provider` flag on subsequent runs after the VM is already created.* * **Build from scratch** - If you wish to run `vagrant up` from scratch, on Linux or IntelMac type: + If you wish to run `vagrant up` from scratch, on Linux or Intel-based Mac type: ``` FROM_SCRATCH=1 vagrant up ``` From 2b89d50b4d76dfe4ae2615be2f565d7b6150910a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A1tvik=20Karanam?= <89281036+skara9@users.noreply.github.com> Date: Tue, 6 Aug 2024 15:08:45 -0400 Subject: [PATCH 2/6] update sidebar --- navtreedata.js | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/navtreedata.js b/navtreedata.js index 00cf62f1..10542796 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -195,9 +195,7 @@ var NAVTREE = [ "Review a Pull Request", "/developer/getting_started/review_a_pull_request", null ], [ "Commit to PR from Fork", "/developer/getting_started/commit_to_PR_from_fork", null ], [ "Edit Submitty Documentation", "/developer/getting_started/edit_submitty_documentation", null ], - [ "VM Install using Vagrant", "/developer/getting_started/vm_install_using_vagrant", [ - [ "Vagrant QEMU on Apple Silicon", "/developer/getting_started/vm_install_using_vagrant_apple_silicon", null ] - ] ], + [ "VM Install using Vagrant", "/developer/getting_started/vm_install_using_vagrant", null ], [ "Advanced Setup", "/developer/getting_started/phpstorm", [ [ "PhpStorm Setup Instructions", "/developer/getting_started/phpstorm", null ], [ "Xdebug Setup Instructions", "/developer/getting_started/xdebug", null ], From 7a391eb99cb4c6077bc9379074f08dd9f194c4a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A1tvik=20Karanam?= <89281036+skara9@users.noreply.github.com> Date: Tue, 6 Aug 2024 15:15:11 -0400 Subject: [PATCH 3/6] more fixes --- .../vm_install_using_vagrant.md | 96 ++++++++++--------- 1 file changed, 49 insertions(+), 47 deletions(-) diff --git a/_docs/developer/getting_started/vm_install_using_vagrant.md b/_docs/developer/getting_started/vm_install_using_vagrant.md index 7aa6be5a..3dd12210 100644 --- a/_docs/developer/getting_started/vm_install_using_vagrant.md +++ b/_docs/developer/getting_started/vm_install_using_vagrant.md @@ -239,68 +239,70 @@ operating system. * **Build pre-packaged VM** - *NOTE: The pre-packaged Submitty VM is not (yet) - available for qemu / M-Series ARM Mac machines.* - - If you are using VirtualBox as your provider, you will by default - use a pre-packaged Submitty VM. This will have all of Submitty - already setup. This is a recently built machine, - but it may be slightly older than the current - [main branch on GitHub](https://github.com/Submitty/Submitty). - - - To create the virtual machine from the pre-packaged image, run: - ``` - vagrant up --provider=virtualbox - ``` - - If you wish to use a specific version of the pre-packaged Submitty VM, on Linux/MacOS type: - ``` - PREBUILT_VERSION={version} vagrant up --provider=virtualbox - ``` - - or on Windows, type: - ``` - SET PREBUILT_VERSION={version} - vagrant up --provider=virtualbox - ``` - - *The version must be only the numbers, not including the `v` in front, for example `24.05.00.2405260215` not `v24.05.00.2405260215`* - - *This process will take 10 minutes to maybe half an hour - depending on your internet connection speed.* - - - ***Note:** The vagrant up command creates and provisions the virtual machine on the first run. - The `--provider` flag is important if you have more than one provider - installed on your machine (e.g., VirtualBox, VMWare, QEMU, libvirt). - For subsequent runs, you do not need to append the `--provider` flag as the VM is - already created.* + *NOTE: The pre-packaged Submitty VM is not (yet) + available for qemu / M-Series ARM Mac machines.* + + If you are using VirtualBox as your provider, you will by default + use a pre-packaged Submitty VM. This will have all of Submitty + already setup. This is a recently built machine, + but it may be slightly older than the current + [main branch on GitHub](https://github.com/Submitty/Submitty). + + + To create the virtual machine from the pre-packaged image, run: + ``` + vagrant up --provider=virtualbox + ``` + + If you wish to use a specific version of the pre-packaged Submitty VM, on Linux/MacOS type: + ``` + PREBUILT_VERSION={version} vagrant up --provider=virtualbox + ``` + + or on Windows, type: + ``` + SET PREBUILT_VERSION={version} + vagrant up --provider=virtualbox + ``` + + *The version must be only the numbers, not including the `v` in front, for example `24.05.00.2405260215` not `v24.05.00.2405260215`* + + *This process will take 10 minutes to maybe half an hour + depending on your internet connection speed.* + + + ***Note:** The vagrant up command creates and provisions the virtual machine on the first run. + The `--provider` flag is important if you have more than one provider + installed on your machine (e.g., VirtualBox, VMWare, QEMU, libvirt). + For subsequent runs, you do not need to append the `--provider` flag as the VM is + already created.* * **Build (from scratch) using QEMU on an M-Series Arm MacOS** - If you have an M-series ARM Mac, run: - ``` - vagrant up --provider=qemu - ``` - - *As noted above, you do not need to append the `--provider` flag on subsequent runs after the VM is already created.* + If you have an M-series ARM Mac, run: + ``` + vagrant up --provider=qemu + ``` + + *As noted above, you do not need to append the `--provider` flag on subsequent runs after the VM is already created.* * **Build from scratch** If you wish to run `vagrant up` from scratch, on Linux or Intel-based Mac type: ``` - FROM_SCRATCH=1 vagrant up + FROM_SCRATCH=1 vagrant up --virtualbox ``` Or on Windows, type: ``` SET FROM_SCRATCH=1 - vagrant up + vagrant up --virtualbox ``` + *As noted above, you do not need to append the `--provider` flag on subsequent runs after the VM is already created.* + *This process will take anywhere from 30 minutes to a few hours depending on your internet speed.* @@ -325,13 +327,13 @@ operating system. * On Mac or Linux: ``` - NO_SUBMISSIONS=1 vagrant up + NO_SUBMISSIONS=1 vagrant up --provider=... ``` * Or on Windows using `cmd`: ``` SET NO_SUBMISSIONS=1 - vagrant up + vagrant up --provider=... ``` Or on Windows using PowerShell, you will have to set the environment variable differently: From cc47c6f13b55367d70f3a505c94163bf1091c1de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A1tvik=20Karanam?= <89281036+skara9@users.noreply.github.com> Date: Tue, 6 Aug 2024 15:23:12 -0400 Subject: [PATCH 4/6] clarify no submissions only works from scratch --- .../vm_install_using_vagrant.md | 26 +++++++++++++------ 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/_docs/developer/getting_started/vm_install_using_vagrant.md b/_docs/developer/getting_started/vm_install_using_vagrant.md index 3dd12210..e4fedfab 100644 --- a/_docs/developer/getting_started/vm_install_using_vagrant.md +++ b/_docs/developer/getting_started/vm_install_using_vagrant.md @@ -316,7 +316,7 @@ operating system. users in the sample courses.* - * **Build without sample submissions** + * **Build from scratch without sample submissions** If your development work *will not require sample assignment submissions or autograding results*, you may prepend @@ -324,42 +324,52 @@ operating system. creation of these sample submissions and their autograding and decrease the time to complete installation. + * On Linux or Intel-based Mac: + ``` + NO_SUBMISSIONS=1 FROM_SCRATCH=1 vagrant up --provider=virtualbox + ``` - * On Mac or Linux: + * On M-series ARM Mac: ``` - NO_SUBMISSIONS=1 vagrant up --provider=... + NO_SUBMISSIONS=1 vagrant up --provider=qemu ``` - * Or on Windows using `cmd`: + * On Windows using `cmd`: ``` SET NO_SUBMISSIONS=1 - vagrant up --provider=... + SET FROM_SCRATCH=1 + vagrant up --provider=virtualbox ``` - Or on Windows using PowerShell, you will have to set the environment variable differently: + On Windows using PowerShell, you will have to set the environment variables differently: ```pwsh $Env:NO_SUBMISSIONS=1 + $Env:FROM_SCRATCH=1 vagrant up ``` - If you want to unset the variable later in `cmd`, you can do: + If you want to unset the variables later in `cmd`, you can do: ``` SET NO_SUBMISSIONS= + SET FROM_SCRATCH= ``` Or in PowerShell: ```pwsh Remove-Item Env:\NO_SUBMISSIONS + Remove-Item Env:\FROM_SCRATCH ``` - Similarly, you can check that the variable is set by doing: + Similarly, you can check that the variables are set in `cmd` with: ``` SET NO_SUBMISSIONS + SET FROM_SCRATCH ``` Or in PowerShell: ```pwsh $Env:NO_SUBMISSIONS + $Env:FROM_SCRATCH ``` From 929d9f59c6474b55edafd4d48a61e0c8e8cd441f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A1tvik=20Karanam?= <89281036+skara9@users.noreply.github.com> Date: Tue, 6 Aug 2024 15:23:59 -0400 Subject: [PATCH 5/6] small fix --- _docs/developer/getting_started/vm_install_using_vagrant.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/developer/getting_started/vm_install_using_vagrant.md b/_docs/developer/getting_started/vm_install_using_vagrant.md index e4fedfab..36856149 100644 --- a/_docs/developer/getting_started/vm_install_using_vagrant.md +++ b/_docs/developer/getting_started/vm_install_using_vagrant.md @@ -295,7 +295,7 @@ operating system. FROM_SCRATCH=1 vagrant up --virtualbox ``` - Or on Windows, type: + Or on Windows with `cmd`, type: ``` SET FROM_SCRATCH=1 vagrant up --virtualbox From f9820292d7cf355a005d2fe63db3990d0d9b5d3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A1tvik=20Karanam?= <89281036+skara9@users.noreply.github.com> Date: Tue, 6 Aug 2024 15:27:29 -0400 Subject: [PATCH 6/6] small fix --- _docs/developer/getting_started/vm_install_using_vagrant.md | 4 ++-- 1 file 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 36856149..ca903f3c 100644 --- a/_docs/developer/getting_started/vm_install_using_vagrant.md +++ b/_docs/developer/getting_started/vm_install_using_vagrant.md @@ -51,8 +51,8 @@ operating system. 5. If you're on M-series ARM MacOS (e.g., M1, M2, M3), you will be using QEMU with SMB file sharing. To enable this, open **System Settings** and navigate to **General > Sharing**. - Press the (i) button next to **File Sharing**, and in thse popup window - click "Options...". Then turn on "Share files and folder using SMB" and + Press the (i) button next to **File Sharing**, and in the popup window + click "Options...". Then turn on "Share files and folders using SMB" and check the box next to your name in the list below. 6. The complete installation process could take an hour or more and