-
Notifications
You must be signed in to change notification settings - Fork 28
feat: adds events related to content library containers [FC-0083] #479
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
feat: adds events related to content library containers [FC-0083] #479
Conversation
|
Thanks for the pull request, @pomegranited! 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. |
|
|
||
| Attributes: | ||
| library_key (LibraryLocatorV2): a key that represents a content library. | ||
| container_key (str): identifies the container within the library's learning package (e.g. unit, section) |
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.
[non-blocking] Should this have its own type, like LibraryLocator or CourseKey, instead of being a plain str? This question also applies for the collection_key in LibraryCollectionData.
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.
I think we can use only the LibraryContainerLocator for the Container events. CC @pomegranited
For the Collections, the events were created before we had a LibraryCollectionLocator, so we needed the LibraryLocator and the collection_key: str to reference it. This can be fixed later.
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.
@mariajgrimaldi Ya, as noted, making that change is blocked on openedx/opaque-keys#369, but we'd be happy to fix this in a follow-up.
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.
@pomegranited @rpenido: agreed! Thank you for pointing me to openedx/opaque-keys#369
Description
Adds events related to libraries v2 containers, e.g. units, sections
Supporting information
Part of: openedx/frontend-app-authoring#1703
Blocks: openedx/openedx-platform#36371
Private-ref: FAL-4052
Testing instructions
Unit tests and coverage should be sufficient for testing this change.
Deadline
ASA
Other information
Include anything else that will help reviewers and consumers understand the change.
Checklists
Check off if complete or not applicable:
Merge Checklist:
Post Merge:
finished.