Update installation instructions, troubleshooting instructions, and CI check failure instructions. #431
Conversation
|
@Helper2020 Please could you review this PR? Thanks! |
|
|
||
| ``` | ||
| sudo apt-get install python3-pip python3-setuptools curl openjdk-8-jre git python3-dev python3-yaml python3-matplotlib unzip libbz2-dev | ||
| sudo apt-get install curl git unzip openjdk-11-jre |
There was a problem hiding this comment.
I think running sudo update-alternatives --config java command should be put here in case the dev has multiple versions and wants to make it default.
There was a problem hiding this comment.
@Helper2020 Thanks, I did put that as a note a little bit below. See https://github.com/oppia/oppia-web-developer-docs/pull/431/files/3e16f6a73a5db9d5d470354735d869a6a1997e38#diff-db30f456b82c07ff1f56b81e92e6713c0efd513783f30dce8394334a5c809ee0R40. WDYT?
There was a problem hiding this comment.
@seanlip Maybe the below note should be moved here since its right after java 11 installed? "Check that Java version 11+ is installed. You can use the command java -version to do this. If you need to change the default binary for the java command, use sudo update-alternatives --config java."
There was a problem hiding this comment.
Thanks @Helper2020, done! PTAL. I also merged the first two steps.
| @@ -111,7 +111,7 @@ Then run `pip install future`. | |||
|
|
|||
| ### No Java | |||
|
|
|||
| If running `which java` on the terminal does not return any output, you do not have java installed. You can install it by running `sudo apt install openjdk-7-jre-headless`. Note that this command might vary for your local machine. | |||
| If running `which java` on the terminal does not return any output, you do not have java installed. You can install it by running `sudo apt install openjdk-11-jre`. Note that this command might vary for your local machine. | |||
There was a problem hiding this comment.
Ah, just saw the LGTM. Thanks, I'll go ahead and merge!
|
@Helper2020 I addressed all comments, PTAL. Thanks! |
|
|
||
| ``` | ||
| sudo apt-get install python3-pip python3-setuptools curl openjdk-8-jre git python3-dev python3-yaml python3-matplotlib unzip libbz2-dev | ||
| sudo apt-get install curl git unzip openjdk-11-jre |
There was a problem hiding this comment.
@seanlip Maybe the below note should be moved here since its right after java 11 installed? "Check that Java version 11+ is installed. You can use the command java -version to do this. If you need to change the default binary for the java command, use sudo update-alternatives --config java."
Update installation instructions to say, make sure you have Java 11 on your machine ("java --version" should show Java 11). We were previously recommending Java 8.
Update https://github.com/oppia/oppia/wiki/If-CI-checks-fail-on-your-PR to escalate if multiple runs fail.
Add [BUG]: Unable to start dev-server using
python -m scripts.start. Subprocess exited with error oppia#21617 to wiki troubleshooting page for MacOS.