openedx / openedx/openedx-platform
Move content_libraries to cms and mark as stable
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
Background
The content_libraries django app, exists in the openedx/ source dir, which is used by both LMS and CMS. This means that all content_libraries-related code is available to be imported and invoked in LMS, which could lead to some unintended bugs or architectural issues down the line.
Opinion: Content libraries are used by authors, but NOT learners or instructions. The entire purpose of content libraries is for authors to create content that is NOT visible to the LMS, and then use that content in their courses. There is no reason that content-libraries-supporting code should need to execute in LMS. (We don't have consensus on this opinion.)
Tasks
Figure out whether content_libraries belongs in openedx/ or cms/.
If it belongs in cms/:
- Move https://github.com/openedx/edx-platform/tree/master/openedx/core/djangoapps/content_libraries under cms/djangoapps. This will require some refactoring, as there are probably already pieces of LMS that use pieces of the content_libraries app.
Details
TBD. Needs refinement.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing openedx/core/djangoapps/content_libraries and searching the repository for LMS and CMS imports or uses of this app. Determine whether the app belongs under cms/djangoapps and identify the refactoring required by those dependencies. Done means ownership is decided, any necessary move and refactor are complete, and the app is marked stable if it is moved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100