Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: add new content authoring event signals #244

Merged
merged 1 commit into from
Jul 20, 2023
Merged

feat: add new content authoring event signals #244

merged 1 commit into from
Jul 20, 2023

Conversation

rpenido
Copy link
Contributor

@rpenido rpenido commented Jun 28, 2023 •
edited
Loading

Description: Create the following OpenEdxPublicSignal events triggered by content creation and editing.

  • XBLOCK_CREATED and XBLOCK_UPDATED
  • COURSE_CREATED
  • CONTENT_LIBRARY_CREATED, CONTENT_LIBRARY_UPDATED and CONTENT_LIBRARY_DELETED
  • LIBRARY_BLOCK_CREATED, LIBRARY_BLOCK_UPDATED and LIBRARY_BLOCK_DELETED

These events will be used in the auto-tagging feature and is part of System Defined Taxonomies feature.
More information: openedx/edx-platform#32599

Related Issue

Reviewers:

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • Create a tag
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)

@openedx-webhooks
Copy link

openedx-webhooks commented Jun 28, 2023 •
edited
Loading

Thanks for the pull request, @rpenido! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 28, 2023
@rpenido rpenido mentioned this pull request Jun 28, 2023
Merged
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jul 3, 2023
@rpenido rpenido force-pushed the rpenido/fal-3434-implement-content-event-signals branch 2 times, most recently from 0968211 to acc20c4 Compare July 3, 2023 22:13
@rpenido rpenido changed the title feat: add new content event signals [WIP] feat: add new content authoring event signals Jul 3, 2023
@rpenido rpenido marked this pull request as ready for review July 3, 2023 22:17
@rpenido rpenido requested a review from a team as a code owner July 3, 2023 22:17
@rpenido rpenido force-pushed the rpenido/fal-3434-implement-content-event-signals branch from acc20c4 to e8a9293 Compare July 3, 2023 22:19
@rpenido rpenido force-pushed the rpenido/fal-3434-implement-content-event-signals branch from f5e5074 to 4d2d951 Compare July 4, 2023 17:20
@rpenido rpenido requested a review from pomegranited July 4, 2023 17:53
@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jul 5, 2023
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jul 5, 2023
@rpenido rpenido force-pushed the rpenido/fal-3434-implement-content-event-signals branch from 8a14215 to e57d4ed Compare July 5, 2023 20:45
pomegranited
pomegranited approved these changes Jul 7, 2023
View reviewed changes
Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

👍 This is looking solid @rpenido !

Could you please update the PR description to reference openedx/edx-platform#32599 as a source of more information for this change?

@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jul 7, 2023
@rpenido rpenido force-pushed the rpenido/fal-3434-implement-content-event-signals branch from e57d4ed to 1d017cb Compare July 10, 2023 14:36
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jul 10, 2023
navinkarkera
navinkarkera approved these changes Jul 11, 2023
View reviewed changes
Copy link
Contributor

@navinkarkera navinkarkera left a comment •
edited
Loading

Choose a reason for hiding this comment

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

@rpenido @pomegranited 👍 Looks good. Just added a small nit.

  • I tested this: (Tested events as described in feat: add new content event signals edx-platform#32599)
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation
  • I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository.

openedx_events/content_authoring/data.py Outdated Show resolved Hide resolved
@mphilbrick211 mphilbrick211 removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jul 11, 2023
@mariajgrimaldi
Copy link
Member

Can you explain how these signals would be used in the tagging feature? Thanks :), it'd be useful for documentation.

@mariajgrimaldi
Copy link
Member

Hi there. Thanks for your contribution! I left a few clarifying questions --non blocking. Thanks :)

@rpenido
Copy link
Contributor Author

rpenido commented Jul 11, 2023

Hi @mariajgrimaldi!

Thank you for your input!

Can you explain how these signals would be used in the tagging feature? Thanks :), it'd be useful for documentation.

The system will automatically generate tags based on the content (author, language, etc..). These events of CREATED/UPDATED content (library, course, blocks, etc..) will trigger the creation and maintenance of these tags. I think @pomegranited can explain this in more detail.

Hi there. Thanks for your contribution! I left a few clarifying questions --non blocking. Thanks :)

I commented in the review! Let me know if I can provide more information!

@pomegranited
Copy link
Contributor

pomegranited commented Jul 13, 2023 •
edited
Loading

Thanks for these comments @rpenido -- could you link to openedx/modular-learning#61 in the PR description, so @mariajgrimaldi and other interested parties to easily see what inspired this change?

@mariajgrimaldi
Copy link
Member

@navinkarkera: you can merge this whenever you can after our comments are addressed. Thank you folks!

@navinkarkera
Copy link
Contributor

@rpenido Have you already responded to our comments? because I am not seeing it (It is possible that you did not click on submit button) nor can I see any changes in the code.

cc: @pomegranited

@rpenido
Copy link
Contributor Author

rpenido commented Jul 17, 2023

@rpenido Have you already responded to our comments? because I am not seeing it (It is possible that you did not click on submit button) nor can I see any changes in the code.

cc: @pomegranited

Sorry @navinkarkera! I think I responded and never submit. Thank you for pointing out!

@rpenido rpenido force-pushed the rpenido/fal-3434-implement-content-event-signals branch 2 times, most recently from db07bd2 to 209b1f1 Compare July 18, 2023 14:54
@rpenido rpenido force-pushed the rpenido/fal-3434-implement-content-event-signals branch from 209b1f1 to 3651679 Compare July 18, 2023 14:55
@rpenido
Copy link
Contributor Author

rpenido commented Jul 19, 2023

Hi @mariajgrimaldi @navinkarkera !

Is there still something that I need to address/clarify to get this merge? Am I missing something?

Thank you!

cc @pomegranited

@mariajgrimaldi
Copy link
Member

Comments addressed! Thanks again folks

@navinkarkera
Copy link
Contributor

@rpenido Thanks for clarifying 💯
Merging this now. cc: @mariajgrimaldi @pomegranited

@navinkarkera navinkarkera merged commit c0eb4ba into openedx:main Jul 20, 2023
6 checks passed
@openedx-webhooks
Copy link

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

@navinkarkera
Copy link
Contributor

@rpenido Version v8.3.0 has been released.

@rpenido rpenido deleted the rpenido/fal-3434-implement-content-event-signals branch July 20, 2023 20:17
@rpenido
Copy link
Contributor Author

rpenido commented Jul 20, 2023

Thank you @navinkarkera!

@JuanDavidBuitrago JuanDavidBuitrago mentioned this pull request Nov 20, 2023
Closed
@JuanDavidBuitrago JuanDavidBuitrago mentioned this pull request Nov 27, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@navinkarkera navinkarkera navinkarkera approved these changes

@mariajgrimaldi mariajgrimaldi mariajgrimaldi left review comments

@pomegranited pomegranited pomegranited approved these changes

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@rpenido @openedx-webhooks @mariajgrimaldi @pomegranited @navinkarkera @e0d @mphilbrick211