Skip to content

Commit

Permalink
Updated installation guide for Docker setup (#318)
Browse files Browse the repository at this point in the history
* Updated installation guide for Docker setup

* moved python setup below docker
  • Loading branch information
jayam04 committed May 1, 2024
1 parent f9502cf commit af57b2f
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions Installing-Oppia.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,23 @@ following:

If you need to learn or brush up on these, please do so before trying to start the installation so you don't get confused by our instructions.

## Standard installation using Python setup
To install Oppia, follow these instructions:

* [[Linux|Installing-Oppia-(Linux;-Python-3)]]
* [[Mac OS|Installing-Oppia-(Mac-OS;-Python-3)]]
* [[Windows|Installing-Oppia-(Windows;-Python-3)]]

## Experimental installation using Docker - under development
## Installation using Docker
To install Oppia using Docker, follow these instructions:
* [[Oppia Docker Setup|Installing-Oppia-using-Docker]]

If you run into any problems during installation, please read [[these notes|Issues-with-installation]] and the [[Troubleshooting page|Troubleshooting]].

Take a look at our [[guide for getting started with some common code editors|Tips-for-common-IDEs]].

If you still face problems, you can open a new discussion in [discussions page](https://github.com/oppia/oppia/discussions/new/choose).

## Python setup (soon to be depreciated)
This setup is soon to be discontinued, please use Docker setup below.

To install Oppia, follow these instructions:

* [[Linux|Installing-Oppia-(Linux;-Python-3)]]
* [[Mac OS|Installing-Oppia-(Mac-OS;-Python-3)]]
* [[Windows|Installing-Oppia-(Windows;-Python-3)]]

**Warning:** You should always edit Oppia code on your local machine. Do not use web-based editors like github.dev or the editor on github.com. These web-based editors won't run the automated checks that run on your local machine. Pushing without these checks just means that the tests will fail on your PR.

0 comments on commit af57b2f

Please sign in to comment.