Associate PublishableEntities with Collections [FC-0062]

pomegranited commented 3 months ago

Description

Adds models and APIs for linking objects (PublishableEntities) to Collections, and for fetching the Collections associated with a given entity.

Supporting information

Part of : https://github.com/openedx/modular-learning/issues/227 Based on : https://github.com/openedx/openedx-learning/pull/131

Private-ref: FAL-3784

Testing instructions

See https://github.com/open-craft/edx-platform/pull/674

openedx-webhooks commented 3 months ago

Thanks for the pull request, @pomegranited!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: 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.

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

:radio_button: 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.

:radio_button: Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @axim-engineering. Tag them in a comment and let them know that your changes are ready for review.

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

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

bradenmacdonald commented 2 months ago

@ormsbee Can you take a quick look at this when you get some time? In particular, if possible, I want to make sure that this is sufficiently general that we can link units/sections/subsections to collections with the same API, even if they're not implemented as XBlocks/Components. Is PublishableEntity the right "thing" to use here then?

ormsbee commented 2 months ago

@bradenmacdonald: I'll do a full review now this afternoon, but yes, PublishableEntity is the correct generic thing to join against to get all the different publishable things.

pomegranited commented 2 months ago

Thanks for your review @rpenido :) How's this looking now, @ormsbee ?

openedx-webhooks commented 2 months ago

@pomegranited 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

openedx / openedx-learning