Devstack #################

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

DEPRECATION NOTICE

---

Going forward, devstack will be primarily used for development by 2U. To do development on Open edX, it is recommended that Tutor_ be used instead.

For more information on this deprecation, please visit the associated deprecation ticket_.

.. _Tutor: https://docs.tutor.edly.io/ .. _associated deprecation ticket: https://github.com/openedx/devstack/issues/907

Getting Started

---

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

.. _Getting Started guide: https://edx.readthedocs.io/projects/open-edx-devstack/en/latest/getting_started.html

Getting Help

---

Documentation

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

.. _the documentation: https://edx.readthedocs.io/projects/open-edx-devstack/en/latest

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.

.. _Slack invitation: https://openedx.org/slack .. _community Slack workspace: https://openedx.slack.com/ .. _Getting Help: https://openedx.org/getting-help

License

---

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

Please see LICENSE <LICENSE>_ for details.

Contributing

---

Contributions are very welcome. Please read How To Contribute <https://openedx.org/r/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_.

.. _Open edX Code of Conduct: https://openedx.org/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 security@openedx.org.

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

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

.. |doc-badge| image:: https://readthedocs.org/projects/open-edx-devstack/badge/?version=latest :target: https://open-edx-devstack.readthedocs.io/en/latest/ :alt: Documentation

.. |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