The Course Discovery API is a data aggregator with several purposes:
The Course Discovery service is a data aggregator with several purposes:
1. Allow external parties to access data about Courses in an OpenEdX installation
from a single central location (no matter which the system of record for that
data is), in a way that can be secured and will not have operational impact
on the running OpenEdX installation.
2. Allow other services inside an OpenEdX installation to consume a consolidated
source of course content for presentation to users (for instance, for
the purposes of course marketing and discoverability).
3. Provide a facility for naming dynamic groups of courses (catalogs) for
use by other services in the system (such as coupon fulfillment and external
course discovery filtering).
To aid in these goals, the Course Discovery Service will collect data from
1. Allow external parties to access data about Courses in an OpenEdX installation from a single central location (no matter which the system of record for that data is), in a way that can be secured and will not have operational impact on the running OpenEdX installation.
several systems internal to the OpenEdX installation. Initially, this will
2. Allow other services inside an OpenEdX installation to consume a consolidated source of course content for presentation to users (for instance, for the purposes of course marketing and discoverability).
just be Otto (the E-Commerce Service), and in the future it will also include
3. Provide a facility for naming dynamic groups of courses (catalogs) for use by other services in the system (such as coupon fulfillment and external course discovery filtering).
Studio, and in the edX.org implementation, our Drupal marketing site. The design
intention is that additional systems should be cheap to add to the same framework.
To aid in these goals, the Course Discovery Service collects data from several systems internal to the Open edX installation. These include Otto (the E-Commerce Service), Studio, and in the edX.org implementation, the Drupal marketing site. The data loading framework is designed to make adding additional systems easy.
The docs for Course Discovery Service will be on Read the Docs: https://open-edx-course-catalog.readthedocs.org.
`Documentation <https://open-edx-course-catalog.readthedocs.io/en/latest/>`_ is hosted on Read the Docs. The source is hosted in this repo's `docs <https://github.com/edx/course-discovery/tree/master/docs>`_ directory. To contribute, please open a PR against this repo.
License
License
-------
-------
The code in this repository is licensed under AGPL unless
The code in this repository is licensed under version 3 of the AGPL unless otherwise noted. Please see the LICENSE_ file for details.
Contributions are welcome. Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details. Even though it was written with ``edx-platform`` in mind, these guidelines should be followed for Open edX code in general.
Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.
Even though they were written with ``edx-platform`` in mind, the guidelines
should be followed for Open edX code in general.
Reporting Security Issues
Reporting Security Issues
-------------------------
-------------------------
Please do not report security issues in public. Please email security@edx.org.
Please do not report security issues in public. Please email security@edx.org.
Mailing List and IRC Channel
Get Help
----------------------------
--------
You can discuss this code in the `edx-code Google Group`__ or in the ``#edx-code`` IRC channel on Freenode.
Ask questions and discuss this project on `Slack <https://openedx.slack.com/messages/general/>`_ or in the `edx-code Google Group <https://groups.google.com/forum/#!forum/edx-code>`_.
