README.md 3.38 KB
Newer Older
1 2 3
This is the main edX platform which consists of LMS and Studio.

See [code.edx.org](http://code.edx.org/) for other parts of the edX code base.
4

5 6
Installation
------------
7

8
Please refer to the following wiki pages in our [configuration repo](https://github.com/edx/configuration) to install edX:
9

10
* [edX Developer Stack](https://github.com/edx/configuration/wiki/edX-Developer-Stack)
11
<br/>These instructions are for developers who want to contribute or make changes to the edX source code.
12
* [edX Production Stack](https://github.com/edx/configuration/wiki/edX-Production-Stack)
13
<br/>Using Vagrant/Virtualbox this will setup all edX services on a single server in a production like configuration.
14
* [edX Ubuntu 12.04 64-bit Installation](https://github.com/edx/configuration/wiki/edX-Ubuntu-12.04-64-bit-Installation)
15
<br/>This will install edX on an existing Ubuntu 12.04 server.
16

17

18 19 20 21
License
-------

The code in this repository is licensed under version 3 of the AGPL unless
22 23 24
otherwise noted. Please see the
[`LICENSE`](https://github.com/edx/edx-platform/blob/master/LICENSE) file
for details.
25

26
Documentation
David Baumgold committed
27
-------------
28

29 30
Documentation for developers, researchers, and course staff is located in the
`docs` subdirectory. Documentation is built using
31
[Sphinx](http://sphinx-doc.org/): you can [view the built documentation on
32
ReadTheDocs](http://docs.edx.org/).
33

David Baumgold committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
Getting Help
------------

If you're having trouble, we have several different mailing lists where you can
ask for help:

* [openedx-ops](https://groups.google.com/forum/#!forum/openedx-ops):
  everything related to *running* Open edX. This includes
  installation issues, server management, cost analysis, and so on.
* [openedx-translation](https://groups.google.com/forum/#!forum/openedx-translation):
  everything related to *translating* Open edX into
  other languages. This includes volunteer translators, our internationalization
  infrastructure, issues related to Transifex, and so on.
* [openedx-analytics](https://groups.google.com/forum/#!forum/openedx-analytics):
  everything related to *analytics* in Open edX.
* [edx-code](https://groups.google.com/forum/#!forum/edx-code):
  everything related to the *code* in Open edX. This includes
  feature requests, idea proposals, refactorings, and so on.

You can also join our IRC channel: [`#edx-code` on Freenode](http://webchat.freenode.net/?channels=edx-code).

Issue Tracker
-------------

[We use JIRA for our issue tracker](https://openedx.atlassian.net/), not
GitHub Issues. To file a bug or request a new feature, please make a free
60 61 62 63
account on our JIRA and create a new issue! If you're filing a bug,
we'd appreciate it if you would follow
[our guidelines for filing high-quality, actionable bug reports](https://openedx.atlassian.net/wiki/display/SUST/How+to+File+a+Quality+Bug+Report).
Thanks!
David Baumgold committed
64

65 66 67
How to Contribute
-----------------

68 69 70 71 72 73
Contributions are very welcome, but for legal reasons, you must submit a signed
[individual contributor's agreement](http://code.edx.org/individual-contributor-agreement.pdf)
before we can accept your contribution. See our
[CONTRIBUTING](https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst)
file for more information -- it also contains guidelines for how to maintain
high code quality, which will make your contribution more likely to be accepted.
74 75 76

Reporting Security Issues
-------------------------
77

78
Please do not report security issues in public. Please email security@edx.org