Skip to content

[Documentation:Developer] Add new ENV variables #616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 21 additions & 10 deletions _docs/developer/getting_started/vm_install_using_vagrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,28 +244,39 @@ If you using an Intel-based Mac, you will follow the instructions below._

* **Build pre-packaged VM**

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. Vagrant will build your VM for you.
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. Vagrant will build your VM for you.

```
vagrant up
```
```
vagrant up
```

If you wish to use a specific version of the pre-packaged Submitty VM, on Linux or Mac type:
```
PREBUILT_VERSION={version} vagrant up
```
or on Windows, type:
```
SET PREBUILT_VERSION={version}
vagrant up
```
*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.*
*This process will take 10 minutes to maybe half an hour
depending on your internet connection speed.*


* **Build from scratch**

If you wish to run `vagrant up` from scratch, on Linux or Mac type:
```
BASE_BOX=1 vagrant up
FROM_SCRATCH=1 vagrant up
```

Or on Windows, type:
```
SET BASE_BOX=1
SET FROM_SCRATCH=1
vagrant up
```

Expand Down
11 changes: 11 additions & 0 deletions _docs/developer/troubleshooting/installation_troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,17 @@ with no explanation, then there are a couple of things that may be going wrong:
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 you are not using the prebuilt Submitty VM, and you get an error like
```
FileNotFoundError: [Errno 2] No such file or directory: '/tmp/tmpad2cfj3v/abernl'
```
This is a known issue with our implementation of Git gradeables, which will be resolved when we have the time. Until then, you can do.
```
NO_SUBMISSIONS=1 vagrant up
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, instead of NO_SUBMISSIONS=1, I have been using your branch minus_git as I often need to work with gradeables. I know Barb has the ultimate fix ready soon, but until then should we rather encourage devs to vagrant up from that branch instead? (and update doc)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since Barb has fixed Git gradeables, I have removed the tip from the docs.

```

__This will not have submissions in the VM, so you will have to manually add some__

* 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
Expand Down
Loading