Skip to content
This repository has been archived by the owner on Dec 11, 2024. It is now read-only.

Latest commit

 

History

History
128 lines (92 loc) · 5.01 KB

README.rst

File metadata and controls

128 lines (92 loc) · 5.01 KB
Raw

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 12.04 64-bit Installation: This will install edX on an existing Ubuntu 12.04 server.

License

The code in this repository is licensed under version 3 of the AGPL unless otherwise noted. Please see the LICENSE file for details.

The Open edX Portal

See the Open edX Portal 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.

To comment on blog posts or the edX roadmap, you must create an account and log in. If you do not have an account, follow these steps.

  1. Visit open.edx.org/user/register.
  2. Fill in your personal details.
  3. Select Create New Account. You are then logged in to the Open edX Portal.

Documentation

Documentation is managed in the edx-documentation repository. Documentation is built using Sphinx: you can view the built documentation on ReadTheDocs.

You can also check out Confluence, our wiki system. Once you sign up for an account, you'll be able to create new pages and edit existing pages, just like in any other wiki system. You only need one account for both Confluence and JIRA, our issue tracker.

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.

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!

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 [email protected].