-
Notifications
You must be signed in to change notification settings - Fork 4.2k
ADR docs: justify a new CMS app for course to library import #36380
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ADR docs: justify a new CMS app for course to library import #36380
Conversation
|
Thanks for the pull request, @cmltaWt0! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
|
Could you mention how this compares to #27715 and/or if we'll be removing that code as part of this work? |
Let me re-phase the Context part regarding the relation to the current import capabilities (I've incorrectly describe it). So I meant that we do not have this type of imports yet - will update the ADR. I do not think we will replace the mentioned import API. |
dbd5671 to
98e5ab0
Compare
Implementing the Epic-11.5 of Library Overhaul project we a going to create a new CMS app import_from_modulestore. This ADR is intented to be a justification of the app creation along with some architecture details of the app.
98e5ab0 to
be4487b
Compare
bradenmacdonald
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This makes sense to me so far but I still don't understand how it compares to content_libraries_import.py - will we be able to delete that one when this one is ready, or will that import command use this new import log? I don't want us to have two different import mechanisms that do similar things.
| As part of the Library Overhaul project, a new feature is required to | ||
| handle a course content import process from the Modulestore into a | ||
| Learning Core based Learning Package preserving the Import Log. | ||
| This feature will enable users to populate Learning Package (today, that | ||
| is always Content Libraries) with existing course structures and content. | ||
| Currently, there is no mechanism to manage the Import process gradually | ||
| preserving the Import Log for a further analyze. | ||
| This creates a significant manual effort when users want to reuse existing | ||
| course content within a library. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggested edits for simplicity / grammar:
| As part of the Library Overhaul project, a new feature is required to | |
| handle a course content import process from the Modulestore into a | |
| Learning Core based Learning Package preserving the Import Log. | |
| This feature will enable users to populate Learning Package (today, that | |
| is always Content Libraries) with existing course structures and content. | |
| Currently, there is no mechanism to manage the Import process gradually | |
| preserving the Import Log for a further analyze. | |
| This creates a significant manual effort when users want to reuse existing | |
| course content within a library. | |
| As part of the Libraries Overhaul project, a new feature is required to | |
| handle the course content import process. This feature will enable | |
| users to populate a Content Library with existing course structures | |
| and content (from a Modulestore course into a Learning Core based | |
| Library / Learning Package, preserving the details in an Import Log). | |
| Currently, there is no mechanism to manage the Import process gradually | |
| nor to create an Import Log for further analysis; this creates a significant | |
| manual effort when users want to reuse existing course content within a library. |
| The application will provide the following functionality: | ||
|
|
||
| * A Python API for programmatic access to the import functionality. | ||
| * A REST API for external interactions (e.g., from the frontend). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * A REST API for external interactions (e.g., from the frontend). | |
| * A REST API for external interactions (e.g. from the frontend). |
|
I'll wrap this one up and get it merged. Working on it over here: #36545 |
|
I'll integrate Braden's comments in over there. |
Implementing the Epic-11.5 of Library Overhaul project we a going to create a new CMS app course_to_library_import.
This ADR is intented to be a justification of the app creation along with some architecture details of the app.