Open edX Devstack

Purpose

Devstack is a local Docker-based environment for developing in the Open edX platform. Use it to get up and running quickly with Open edX services.

Getting Started

The Getting Started guide lives with the rest of the documentation in Read the Docs.

Getting Help

Documentation

Start by going through the documentation on Read the Docs. If you need more help see below.

More Help

If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace.

For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.

https://github.com/openedx/devstack/issues

For more information about these options, see the Getting Help page.

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE for details.

Contributing

Contributions are very welcome. Please read How To Contribute for details.

This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to have a discussion about your new feature idea with the maintainers prior to beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.

The Open edX Code of Conduct

All community members are expected to follow the Open edX Code of Conduct.

People

TODO: Create catalog-info.yaml for Backstage, and update this section.

Reporting Security Issues

Please do not report security issues in public. Please email [email protected].