Note
This README was auto-generated. Maintainer: please review its contents and update all relevant sections. Instructions to you are marked with "PLACEHOLDER" or "TODO". Update or remove those sections, and remove this note when you are done.
An integrated channel is an abstraction meant to represent a third-party system which provides an API that can be used to transmit EdX data to the third-party system.
TODO: The README.rst file should start with a brief description of the repository and its purpose.
It should be described in the context of other repositories under the openedx
organization. It should make clear where this fits into the overall Open edX
codebase and should be oriented towards people who are new to the Open edX
project.
Please see the Open edX documentation for guidance on Python development in this repo.
TODO: How can a new user go about deploying this component? Is it just a few commands? Is there a larger how-to that should be linked here?
PLACEHOLDER: For details on how to deploy this component, see the deployment how-to.
PLACEHOLDER: Start by going through the documentation. If you need more help see below.
(TODO: Set up documentation)
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/enterprise-integrated-channels/issues
For more information about these options, see the Getting Help page.
The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
Please see LICENSE.txt for details.
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 discuss your new feature idea with the maintainers before 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.
All community members are expected to follow the Open edX Code of Conduct.
The assigned maintainers for this component and other project details may be
found in Backstage. Backstage pulls this data from the catalog-info.yaml
file in this repo.
Please do not report security issues in public. Please email security@openedx.org.