docs: Update the readme.

* Re-rule the file to match the current standards.
* Add a "Dependencies" section that outlines the interpreter and service
  dependencies for the edx-platform codebase.  It's not comprehensiv but
  I couldn't find anything anywhere that was so start with something
  here for now.
This commit is contained in:
Feanil Patel
2023-05-08 10:02:00 -04:00
parent a4be3a17eb
commit 4e043de248

View File

@@ -1,4 +1,3 @@
#################
Open edX Platform Open edX Platform
################# #################
| |License: AGPL v3| |Status| |Python CI| | |License: AGPL v3| |Status| |Python CI|
@@ -12,7 +11,7 @@ Open edX Platform
.. |Status| image:: https://img.shields.io/badge/status-maintained-31c653 .. |Status| image:: https://img.shields.io/badge/status-maintained-31c653
Purpose Purpose
------- *******
The `Open edX Platform <https://openedx.org>`_ is a service-oriented platform for authoring and The `Open edX Platform <https://openedx.org>`_ is a service-oriented platform for authoring and
delivering online learning at any scale. The platform is written in delivering online learning at any scale. The platform is written in
Python and JavaScript and makes extensive use of the Django Python and JavaScript and makes extensive use of the Django
@@ -27,7 +26,7 @@ platform. Functionally, the edx-platform repository provides two services:
* LMS (Learning Management Service), which delivers learning content. * LMS (Learning Management Service), which delivers learning content.
Installation Installation
------------ ************
Installing and running an Open edX instance is not simple. We strongly Installing and running an Open edX instance is not simple. We strongly
recommend that you use a service provider to run the software for you. They recommend that you use a service provider to run the software for you. They
@@ -43,8 +42,28 @@ so, `Open edX Installation Options`_ explains your options.
.. _Open edX Developer Stack: https://github.com/openedx/devstack .. _Open edX Developer Stack: https://github.com/openedx/devstack
.. _Open edX Installation Options: https://openedx.atlassian.net/wiki/spaces/OpenOPS/pages/60227779/Open+edX+Installation+Options .. _Open edX Installation Options: https://openedx.atlassian.net/wiki/spaces/OpenOPS/pages/60227779/Open+edX+Installation+Options
Dependencies
============
In order to build and run this code you'll need the following available on your
system:
Interperters/Tools:
* Python 3.8
* Node 16
Services:
* MySQL 5.7
* Mongo 4.x
* Memcached
License License
------- *******
The code in this repository is licensed under version 3 of the AGPL The code in this repository is licensed under version 3 of the AGPL
unless otherwise noted. Please see the `LICENSE`_ file for details. unless otherwise noted. Please see the `LICENSE`_ file for details.
@@ -53,7 +72,7 @@ unless otherwise noted. Please see the `LICENSE`_ file for details.
More about Open edX More about Open edX
------------------- *******************
See the `Open edX site`_ to learn more about the Open edX world. You can find See the `Open edX site`_ to learn more about the Open edX world. You can find
information about hosting, extending, and contributing to Open edX software. In information about hosting, extending, and contributing to Open edX software. In
@@ -63,13 +82,13 @@ and other rich community resources.
.. _Open edX site: https://openedx.org .. _Open edX site: https://openedx.org
Documentation Documentation
------------- *************
Documentation can be found at https://docs.edx.org. Documentation can be found at https://docs.openedx.org.
Getting Help Getting Help
------------ ************
If you're having trouble, we have discussion forums at If you're having trouble, we have discussion forums at
https://discuss.openedx.org where you can connect with others in the community. https://discuss.openedx.org where you can connect with others in the community.
@@ -85,7 +104,7 @@ For more information about these options, see the `Getting Help`_ page.
Issue Tracker Issue Tracker
------------- *************
We use JIRA for our issue tracker, not GitHub issues. You can search We use JIRA for our issue tracker, not GitHub issues. You can search
`previously reported issues`_. If you need to report a problem, `previously reported issues`_. If you need to report a problem,
@@ -96,7 +115,7 @@ please make a free account on our JIRA and `create a new issue`_.
How to Contribute How to Contribute
----------------- *****************
Contributions are welcome! The first step is to submit a signed Contributions are welcome! The first step is to submit a signed
`individual contributor agreement`_. See our `CONTRIBUTING`_ file for more `individual contributor agreement`_. See our `CONTRIBUTING`_ file for more
@@ -105,7 +124,7 @@ quality, which will make your contribution more likely to be accepted.
Reporting Security Issues Reporting Security Issues
------------------------- *************************
Please do not report security issues in public. Please email Please do not report security issues in public. Please email
security@edx.org. security@edx.org.