Updated Installation Doc for Python - Linux, Windows#435
Open
jayam04 wants to merge 2 commits intooppia:developfrom
Open
Updated Installation Doc for Python - Linux, Windows#435jayam04 wants to merge 2 commits intooppia:developfrom
jayam04 wants to merge 2 commits intooppia:developfrom
Conversation
…hon; Also made installation page prettier.
seanlip
requested changes
Jan 16, 2025
| 1. Create a new, empty folder that will hold your Oppia work. Here, we call the folder `opensource`. | ||
|
|
||
| 2. Navigate to the folder (`cd opensource/`). Next, we'll [fork and clone](https://help.github.com/articles/fork-a-repo/) the Oppia repository. | ||
| 2. Navigate to the folder (`cd opensource/`). Next, we'll [fork and clone](https://help.github.com/articles/fork-a-repo/) the Oppia repository, as described in below steps. |
Member
There was a problem hiding this comment.
...in the steps below.
(Or just drop the 2nd sentence here and, in step 3, you can say "click on the fork button to fork Oppia's repository", where "fork Oppia's repository" is linked to https://help.github.com/articles/fork-a-repo/ .)
|
|
||
| *These installation instructions were last tested on 8 January 2024. For more information on issues that may occasionally arise with the installation process, see the [Troubleshooting](https://github.com/oppia/oppia/wiki/Troubleshooting) page or ask in the [GitHub Discussions](https://github.com/oppia/oppia/discussions).* | ||
| > [!NOTE] | ||
| > These installation instructions were last tested on 8 January 2024. For more information on issues that may occasionally arise with the installation process, see the [Troubleshooting](https://github.com/oppia/oppia/wiki/Troubleshooting) page or ask in the [GitHub Discussions](https://github.com/oppia/oppia/discussions). |
Member
There was a problem hiding this comment.
nit: ask in GitHub Discussions (drop "the")
| > The commands below can be executed in any directory, as they are not path-specific. | ||
| 1. **Make sure you install the Python build dependencies for your operating system. These are specified [here](https://github.com/pyenv/pyenv/wiki#suggested-build-environment). If you don't do this it might lead to problems further on.** The build dependencies for Ubuntu/Debian are | ||
|
|
||
| > [NOTE!] |
Member
There was a problem hiding this comment.
I don't think this is working correctly, see the rich diff preview.
| ``` | ||
|
|
||
| 2. Install pyenv: | ||
| 2. Install pyenv using [installation steps](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation). |
Member
There was a problem hiding this comment.
... using these installation steps: [link]
Or just say "Install pyenv." and link the whole text to that link.
| ``` | ||
|
|
||
| If you see the warning at the end, add the following lines to your ``>> ~/.bashrc`` (if you are using bash) or ``>> ~/.zshrc`` (if you are using zsh). | ||
| > [!WARNING] |
Member
There was a problem hiding this comment.
These don't seem to be showing up properly in the rich text diff. In future, please do a preview check before submitting for review.
| > Be careful with using graphical editors like Notepad in Windows. These can add carriage returns (`\r`) that confuse our Linux-based development tools. Instead, we recommend using editors designed for programming or command-line text editors. | ||
|
|
||
| 8. Create a virtual environment for oppia by adding file named `.envrc` into the parent folder of the oppia repository | ||
| 8. Create a virtual environment for oppia by adding file named `.envrc` into the parent folder of the oppia repository, which is `opensource/` in this case. |
Member
There was a problem hiding this comment.
Create a virtual environment for Oppia by adding an .envrc file into the parent folder of the oppia repository (opensource/ in this case). The file should have the following content:
| # Table of Contents | ||
|
|
||
| > [!NOTE] | ||
| > Most of scripts in Oppia are designed to support UNIX based systems, this includes Linix and MacOS but not Windows. So, for Windows we have 3 major methods to support this. |
Member
There was a problem hiding this comment.
Most of scripts --> Most scripts
UNIX based systems, this includes --> UNIX-based systems. These include
Linix --> Linux
Also, what does "this" at the end refer to? It's not quite clear, perhaps worth rephrasing. Maybe "to support running these scripts:"?
|
|
||
| > [!NOTE] | ||
| > Most of scripts in Oppia are designed to support UNIX based systems, this includes Linix and MacOS but not Windows. So, for Windows we have 3 major methods to support this. | ||
| > 1. Using Windows Subsystem for Linux 2 (WSL2) (recommended): It's provided by Microsoft and uses lightweight virtual machine with an actual Linux kernel. |
| > [!NOTE] | ||
| > Most of scripts in Oppia are designed to support UNIX based systems, this includes Linix and MacOS but not Windows. So, for Windows we have 3 major methods to support this. | ||
| > 1. Using Windows Subsystem for Linux 2 (WSL2) (recommended): It's provided by Microsoft and uses lightweight virtual machine with an actual Linux kernel. | ||
| > 2. Using Virtual Machine solutions such as Virtualbox, VMWare: It's easier to setup and you will have true Linux environment. However, it adds some overhead and reduces performance. |
Member
There was a problem hiding this comment.
It's --> These are
have true --> have a true
| > Most of scripts in Oppia are designed to support UNIX based systems, this includes Linix and MacOS but not Windows. So, for Windows we have 3 major methods to support this. | ||
| > 1. Using Windows Subsystem for Linux 2 (WSL2) (recommended): It's provided by Microsoft and uses lightweight virtual machine with an actual Linux kernel. | ||
| > 2. Using Virtual Machine solutions such as Virtualbox, VMWare: It's easier to setup and you will have true Linux environment. However, it adds some overhead and reduces performance. | ||
| > 3. Using Docker (caution: in BETA): It's a modern way which packages dependencies and utilizes OS-level virtualization rather than hardware-level. Currently, being in BETA, it still requires WSL, so it's no better than first method. |
jayam04
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Python Installation Linux:
Python Installation Windows: