-
Notifications
You must be signed in to change notification settings - Fork 21
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] explain how the event bus works and how to use it #426
base: main
Are you sure you want to change the base?
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. |
1feabc8
to
3954196
Compare
@@ -1,42 +0,0 @@ | |||
Using the Open edX Event bus |
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.
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.
Maybe we should add a redirect here?
Should these docs live here? Or on docs.openedx.org? (I don't know the right answer just asking) |
Description
This PR adds sections dedicated to the Open edX Event bus technology:
An Overview of the technology:
What is the Open edX Event Bus?
Why use the Open edX Event Bus?
How Does the Open edX Event Bus Work? With an architectural diagram.
How is the Open edX Event Bus Used?
Using the Open edX Event Bus: install event-bus plugins, configure them, produce events, consume events, run the consumer
Event Bus Configurations: the available configurations taken from in-line code annotations.
Glossary terms for the event-bus: event bus, message, message broker, worker, producer, consumer, topic
These docs were written based on the available documentation about the Open edX Event Bus:
https://openedx.atlassian.net/wiki/spaces/AC/pages/3508699151/How+to+start+using+the+Event+Bus
https://openedx.atlassian.net/wiki/spaces/AC/pages/3474784257/Event+Bus+Architecture+Overview
This PR partially addresses #238