Skip to content

Commit 087ab73

Browse files
authored
docs: Update this super old readme (#36865)
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] #5942 (comment)
1 parent bcb3f6b commit 087ab73

1 file changed

Lines changed: 5 additions & 12 deletions

File tree

openedx/README.rst

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,8 @@
1-
Open edX
2-
--------
1+
openedx
2+
-------
33

4-
This is the root package for Open edX. The intent is that all importable code
5-
from Open edX will eventually live here, including the code in the lms, cms,
6-
and common directories.
4+
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.
75

8-
If you're adding a new Django app, place it in core/djangoapps. If you're adding
9-
utilities that require Django, place them in core/djangolib. If you're adding
10-
code that defines no Django models or views of its own but is widely useful, put it
11-
in core/lib.
6+
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.
127

13-
Note: All new code should be created in this package, and the legacy code will
14-
be moved here gradually. For now the code is not structured like this, and hence
15-
legacy code will continue to live in a number of different packages.
8+
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.

0 commit comments

Comments
 (0)