Devstack ########

|ci-provisioning-badge| |ci-cli-badge| |license-badge| |status-badge|

Overview

---

This is 2U's version of devstack used for developing using the Open edX platform.

The Open edX version of devstack was deprecated and archived. Be careful to avoid any outdated documentation from the Open edX Read the Docs or the openedx-unsupported GitHub org. For more information on the Open edX deprecation, please visit the associated deprecation ticket_.

.. _associated deprecation ticket: https://github.com/openedx/devstack/issues/907

Getting Started

---

The Getting Started guide_ lives with the rest of the documentation.

.. _Getting Started guide: https://github.com/edx/devstack/blob/master/docs/getting_started.rst

Getting Help

---

Documentation

Start by going through the documentation_ on GitHub. Our documentation is not yet published to Read the Docs, so you should avoid the outdated Open edX docs on Read the Docs. If you need more help see below.

.. _the documentation: https://github.com/edx/devstack/tree/master/docs

More Help

If you're having trouble, you can discuss in 2U's #tech-devstack-questions_ Slack channel.

.. _#tech-devstack-questions: https://twou.slack.com/archives/C04A66RDPEZ

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/edx/devstack/issues

License

---

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

Please see LICENSE <LICENSE>_ for details.

Contributing

---

This repository is not open for contributions from outside of 2U.

Reporting Security Issues

---

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

.. |ci-provisioning-badge| image:: https://github.com/edx/devstack/actions/workflows/provisioning-tests.yml/badge.svg?branch=master :target: https://github.com/edx/devstack/actions/workflows/provisioning-tests.yml :alt: CI Provisioning

.. |ci-cli-badge| image:: https://github.com/edx/devstack/actions/workflows/cli-tests.yml/badge.svg?branch=master :target: https://github.com/edx/devstack/actions/workflows/cli-tests.yml :alt: CI CLI

.. |license-badge| image:: https://img.shields.io/github/license/openedx/devstack.svg :target: https://github.com/openedx/devstack/blob/master/LICENSE :alt: License

.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen