docs: [FC-0074] add glossary for openedx-events ecosystem #407
Conversation
|
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 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. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
openedx-webhooks
added
the
open-source-contribution
mariajgrimaldi
changed the title
| Event Definition | ||
| An event is a signal that is emitted when a specific action occurs in the platform. The event definition is the instantiation of the ``OpenEdxPublicSignal`` class that defines the structure and metadata of an event. This definition includes information such as the event name, description, payload, and version. Event definitions are used to create events which are later imported into the services and are triggered by using the ``send_event`` method. | ||
|
|
||
| .. _Events Payload ADR: :doc: `/decisions/0003-events-payload` |
There was a problem hiding this comment.
I'm aware definitions about the event bus are missing here, but I'll add them later when I start improving the event bus docs.
There was a problem hiding this comment.
It may be worth adding in the terms, with a definition of "To be added soon" or something so we don't forget?
| Event Definition | ||
| An event is a signal that is emitted when a specific action occurs in the platform. The event definition is the instantiation of the ``OpenEdxPublicSignal`` class that defines the structure and metadata of an event. This definition includes information such as the event name, description, payload, and version. Event definitions are used to create events which are later imported into the services and are triggered by using the ``send_event`` method. | ||
|
|
||
| .. _Events Payload ADR: :doc: `/decisions/0003-events-payload` |
There was a problem hiding this comment.
It may be worth adding in the terms, with a definition of "To be added soon" or something so we don't forget?
|
@sarina: I completely forgot to let you know I addressed your comments 🫠. Thank you for the thorough review! |
|
It looks great now, merge when you're ready! |
Description
This PR: