This directory was created as part of an idea [1] to create top-level openedx namespace which every Open edX package would nest itself under. The README was written with that in mind. That never panned out, so openedx is really just another "common" directory. Non-common code should not be added to it. This update clarifies that. [1] https://github.com/openedx/edx-platform/pull/5942#issuecomment-66117744
9 lines
720 B
ReStructuredText
9 lines
720 B
ReStructuredText
openedx
|
|
-------
|
|
|
|
This directory (openedx) should contain code that is used by both `LMS <https://github.com/openedx/edx-platform/tree/master/lms>`_ and `CMS <https://github.com/openedx/edx-platform/tree/master/cms>`_. If your code is specific to LMS or CMS, put it in those directories instead.
|
|
|
|
Like openedx, the directory `common <https://github.com/openedx/edx-platform/tree/master/common>`_ also contains code used by both LMS and CMS. At some point we'll merge the two.
|
|
|
|
Lastly, the directory `xmodule <https://github.com/openedx/edx-platform/tree/master/xmodule>`_ contains legacy core code, also used by both LMS and CMS. We're in the middle of a long process of phasing that code out. Don't add new code there.
|