Skip to content

[Documentation:Developer] Updated Installation Instructions #622

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.

Sign up for GitHub

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

[Documentation:Developer] Updated Installation Instructions #622

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3bceb8d
updated the documentation for the installation for mac.
Jul 22, 2024
c5be546
removed the unwanted image
Jul 22, 2024
351ae90
Update _docs/developer/troubleshooting/installation_troubleshooting.md
sahilsuman933 Jul 23, 2024
996dcae
Update _docs/developer/getting_started/vm_install_using_vagrant_apple…
sahilsuman933 Jul 23, 2024
5740ccd
removed the troubleshooting guide
sahilsuman933 Jul 26, 2024
52e74d1
renamed the image
sahilsuman933 Sep 7, 2024
412ccff
updated the image path
sahilsuman933 Sep 7, 2024
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
Binary file added _docs/developer/getting_started/img.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion _docs/developer/getting_started/vm_install_using_vagrant_apple_silicon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ the installation process.

* Open **System Settings** and navigate to **Sharing**
* Turn on **File Sharing** and go to options
* Check "Share files and folders using SMB"
* Check "Share files and folders using SMB"
![img.png](img.png)
* click on the i button next to the option "File Sharing"
* Check the box next to your username
* Click Done

Expand Down
Binary file added _docs/developer/troubleshooting/img.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _docs/developer/troubleshooting/img_2.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions _docs/developer/troubleshooting/installation_troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,13 @@ with no explanation, then there are a couple of things that may be going wrong:
```
VM_PORT_SITE=1512 vagrant up
```
* Steps to edit the env file

1. Go to Submitty install directory and locate the file named "Vagrantfile."
2. Open the "Vagrantfile" in a text editor.
Copy link
Contributor

Choose a reason for hiding this comment

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

Developers should not manually edit the Vagrantfile. Doing so will make it difficult for git commit tracking.

Copy link
Member

Choose a reason for hiding this comment

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

This is indeed true, unless dev puts it in git ignore, it can mess with tracking. On my second thought, I think we should revert this change entirely.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, it's true that it will make tracking a little bit difficult, but they should be aware of how they can create the env file.

We can do one thing: add one more line about that to put it in gitignore or not to commit it as a note.

Copy link
Contributor

Choose a reason for hiding this comment

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

Gitignore is also a tracked file, so you will run into even more issues by editing it.
We already have instructions on creating the env file, see the last bullet under https://submitty.org/developer/troubleshooting/installation_troubleshooting#forwarded-port-already-in-use
It used to be the first bullet under the heading, but it looks like it got pushed down by later additions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, let me remove it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Fyi the major issue isn't them accidentally committing it, that can be easily caught.
It's that we don't want new devs to have to worry about nasty merge conflicts every time they pull from main.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I get it.

![img.png](img.png)
3. Identify the port causing the error and change it to a port of your choice.
![img_2.png](img_2.png)

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