Skip to content

Conversation

@cmltaWt0
Copy link
Contributor

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 13, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @cmltaWt0!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@bradenmacdonald
Copy link
Contributor

Could you mention how this compares to #27715 and/or if we'll be removing that code as part of this work?

@cmltaWt0
Copy link
Contributor Author

cmltaWt0 commented Mar 14, 2025

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).
The newly proposed solution (python and rest api) is intended to manage the ImportHistory objects/entities.
So basically the API will allow as to create an intention to start the Import process, review/edit it (remove some xblocks), choose the level of decomposition (aka what level of hierarchy to choose).

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.

@cmltaWt0 cmltaWt0 force-pushed the max/docs/justify-new-app-course-to-library-import branch from dbd5671 to 98e5ab0 Compare March 18, 2025 12:47
@cmltaWt0 cmltaWt0 changed the title [DRAFT] ADR docs: justify a new CMS app for course to library import ADR docs: justify a new CMS app for course to library import Mar 18, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Mar 19, 2025
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.
@cmltaWt0 cmltaWt0 force-pushed the max/docs/justify-new-app-course-to-library-import branch from 98e5ab0 to be4487b Compare March 28, 2025 19:48
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a 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.

Comment on lines +11 to +19
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.
Copy link
Contributor

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:

Suggested change
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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* A REST API for external interactions (e.g., from the frontend).
* A REST API for external interactions (e.g. from the frontend).

@kdmccormick
Copy link
Member

I'll wrap this one up and get it merged. Working on it over here: #36545

@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Apr 17, 2025
@kdmccormick
Copy link
Member

I'll integrate Braden's comments in over there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants