108 lines
4.0 KiB
ReStructuredText
108 lines
4.0 KiB
ReStructuredText
This is the main edX platform which consists of LMS and Studio.
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Please refer to the following wiki pages in our `configuration repo`_ to
|
||
install edX:
|
||
|
||
- `edX Developer Stack`_: These instructions are for developers who want
|
||
to contribute or make changes to the edX source code.
|
||
- `edX Full Stack`_: Using Vagrant/Virtualbox this will setup all edX
|
||
services on a single server in a production like configuration.
|
||
- `edX Ubuntu 16.04 64-bit Installation`_: This will install edX on an
|
||
existing Ubuntu 16.04 server.
|
||
|
||
.. _configuration repo: https://github.com/edx/configuration
|
||
.. _edX Developer Stack: https://github.com/edx/devstack
|
||
.. _edX Full Stack: https://openedx.atlassian.net/wiki/display/OpenOPS/Running+Fullstack
|
||
.. _edX Ubuntu 16.04 64-bit Installation: https://openedx.atlassian.net/wiki/display/OpenOPS/Native+Open+edX+Ubuntu+16.04+64+bit+Installation
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
The code in this repository is licensed under version 3 of the AGPL
|
||
unless otherwise noted. Please see the `LICENSE`_ file for details.
|
||
|
||
.. _LICENSE: https://github.com/edx/edx-platform/blob/master/LICENSE
|
||
|
||
|
||
More about Open edX
|
||
-------------------
|
||
|
||
See the `Open edX site`_ to learn more about Open edX. You can find
|
||
information about the edX roadmap, as well as about hosting, extending, and
|
||
contributing to Open edX. In addition, the Open edX Portal provides product
|
||
announcements, the Open edX blog, and other rich community resources.
|
||
|
||
.. _Open edX site: https://open.edx.org
|
||
|
||
Documentation
|
||
-------------
|
||
|
||
Documentation details can be found in the `docs index.rst`_.
|
||
|
||
.. _docs index.rst: docs/index.rst
|
||
|
||
Getting Help
|
||
------------
|
||
|
||
If you’re having trouble, we have several different mailing lists where
|
||
you can ask for help:
|
||
|
||
- `openedx-ops`_: everything related to *running* Open edX. This
|
||
includes installation issues, server management, cost analysis, and
|
||
so on.
|
||
- `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`_: everything related to *analytics* in Open edX.
|
||
- `edx-code`_: anything else related to Open edX. This includes feature
|
||
requests, idea proposals, refactorings, and so on.
|
||
|
||
Our real-time conversations are on Slack. You can request a `Slack
|
||
invitation`_, then join our `community Slack team`_.
|
||
|
||
.. _openedx-ops: https://groups.google.com/forum/#!forum/openedx-ops
|
||
.. _openedx-translation: https://groups.google.com/forum/#!forum/openedx-translation
|
||
.. _openedx-analytics: https://groups.google.com/forum/#!forum/openedx-analytics
|
||
.. _edx-code: https://groups.google.com/forum/#!forum/edx-code
|
||
.. _Slack invitation: https://openedx-slack-invite.herokuapp.com/
|
||
.. _community Slack team: http://openedx.slack.com/
|
||
|
||
|
||
Issue Tracker
|
||
-------------
|
||
|
||
`We use JIRA for our issue tracker`_, not GitHub Issues. To file a bug
|
||
or request a new feature, please make a free 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`_. Thanks!!
|
||
|
||
.. _We use JIRA for our issue tracker: https://openedx.atlassian.net/
|
||
.. _our guidelines for filing high-quality, actionable bug reports: https://openedx.atlassian.net/wiki/display/SUST/How+to+File+a+Quality+Bug+Report
|
||
|
||
|
||
How to Contribute
|
||
-----------------
|
||
|
||
Contributions are very welcome, but for legal reasons, you must submit a
|
||
signed `individual contributor agreement`_ before we can accept your
|
||
contribution. See our `CONTRIBUTING`_ 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.
|
||
|
||
|
||
Reporting Security Issues
|
||
-------------------------
|
||
|
||
Please do not report security issues in public. Please email
|
||
security@edx.org.
|
||
|
||
.. _individual contributor agreement: https://open.edx.org/wp-content/uploads/2019/01/individual-contributor-agreement.pdf
|
||
.. _CONTRIBUTING: https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst
|