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.

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

docs: [FC-0074] add details for illustrating how events work #420

Merged
merged 9 commits into from
Nov 28, 2024

Conversation

mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Nov 18, 2024

Description

This PR:

  1. Attaches a diagram of how filters work to illustrate better the steps introduced in docs: [FC-0074] add more detailed concepts on events #406.
  2. Improves wording in how events work sections and glossary.
  3. Include more examples to better illustrate behavior.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 18, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Nov 18, 2024

Thanks for the pull request, @mariajgrimaldi!

What's next?

Please work through the following steps to get your changes 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.

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

Who will review my changes?

This repository is currently maintained by @openedx/hooks-extension-framework. 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

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

@mariajgrimaldi mariajgrimaldi added the FC Relates to an Axim Funded Contribution project label Nov 18, 2024
@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review November 18, 2024 20:53
@mariajgrimaldi mariajgrimaldi requested a review from a team as a code owner November 18, 2024 20:53
@sarina
Copy link
Contributor

sarina commented Nov 19, 2024

This looks good, I have two comments:

image

do_something() method isn't explained in the following steps, so it would be good to indicate what this call means.

image

should this be send_event() to match the steps that follow the diagram?

@mariajgrimaldi mariajgrimaldi marked this pull request as draft November 21, 2024 12:29
@mariajgrimaldi
Copy link
Member Author

mariajgrimaldi commented Nov 21, 2024

I'm sorry, this still needs work so I'm turning it into draft.

EDIT: It didn't took me that long!

@mariajgrimaldi mariajgrimaldi changed the title docs: [FC-0074] add diagram for illustrating how events work docs: [FC-0074] add details for illustrating how events work Nov 21, 2024
@mariajgrimaldi mariajgrimaldi force-pushed the MJG/improve-concepts-docs branch from 2ed1f05 to 5138df5 Compare November 21, 2024 14:06
@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review November 21, 2024 14:07
@mariajgrimaldi mariajgrimaldi linked an issue Nov 22, 2024 that may be closed by this pull request
@mariajgrimaldi mariajgrimaldi force-pushed the MJG/improve-concepts-docs branch from 5138df5 to 1656d67 Compare November 25, 2024 12:03
Base automatically changed from MJG/improve-concepts-docs to main November 25, 2024 13:16

Developers can listen to Open edX Events by registering signal receivers from their Open edX Django plugins that respond to the emitted events. This is done using Django's signal mechanism, which allows developers to listen for events and execute custom logic in response.

For more information on using Open edX Events, refer to the `Using Open edX Events`_ how-to guide.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you want to reference the doc here using a :ref: directive?

Copy link
Member Author

Choose a reason for hiding this comment

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

I used :doc: instead, does that work?

Copy link
Contributor

Choose a reason for hiding this comment

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

John Swope told me that :ref: is better, but I think :doc: is reasonable (:ref: works if the doc filepath changes, but :doc: works if the title of the doc or the reference string changes, so, they both have drawbacks)

@sarina
Copy link
Contributor

sarina commented Nov 26, 2024

Merge away!

@mariajgrimaldi mariajgrimaldi merged commit a0e1f1e into main Nov 28, 2024
8 checks passed
@mariajgrimaldi mariajgrimaldi deleted the MJG/arch-diagram branch November 28, 2024 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

How Open edX Events work
4 participants