[Documentation:Developer] Updated Installation Instructions #622
Conversation
Signed-off-by: Sahil Suman <[email protected]>
Signed-off-by: Sahil Suman <[email protected]>
_docs/developer/getting_started/vm_install_using_vagrant_apple_silicon.md
Outdated
Show resolved
Hide resolved
_docs/developer/troubleshooting/installation_troubleshooting.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Jaeseok Kang <[email protected]>
…_silicon.md Co-authored-by: Jaeseok Kang <[email protected]>
| * 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. |
There was a problem hiding this comment.
Developers should not manually edit the Vagrantfile. Doing so will make it difficult for git commit tracking.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Hmm, let me remove it.
There was a problem hiding this comment.
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.
Signed-off-by: sahil suman <[email protected]>
| @@ -155,7 +155,7 @@ with no explanation, then there are a couple of things that may be going wrong: | |||
| ``` | |||
| VM_PORT_SITE=1512 vagrant up | |||
| ``` | |||
|
|
|||
_docs/developer/getting_started/vm_install_using_vagrant_apple_silicon.md
Outdated
Show resolved
Hide resolved
Signed-off-by: sahil suman <[email protected]>
Updated the documentation for the MAC installation as well added images for it.