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] explain how the event bus works and how to use it #426

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Nov 29, 2024

Description

This PR adds sections dedicated to the Open edX Event bus technology:

  1. 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?

  2. Using the Open edX Event Bus: install event-bus plugins, configure them, produce events, consume events, run the consumer

  3. Event Bus Configurations: the available configurations taken from in-line code annotations.

  4. 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

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

openedx-webhooks commented Nov 29, 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 changed the title docs: explain how the event bus works and how to use it docs: [FC-0074] explain how the event bus works and how to use it Nov 29, 2024
@mariajgrimaldi mariajgrimaldi added the FC Relates to an Axim Funded Contribution project label Nov 29, 2024
@@ -1,42 +0,0 @@
Using the Open edX Event bus
Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member Author

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?

@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review December 2, 2024 14:07
@mariajgrimaldi mariajgrimaldi requested a review from a team as a code owner December 2, 2024 14:07
@mariajgrimaldi mariajgrimaldi marked this pull request as draft December 2, 2024 14:08
@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review December 2, 2024 16:16
@sarina
Copy link
Contributor

sarina commented Dec 2, 2024

Should these docs live here? Or on docs.openedx.org? (I don't know the right answer just asking)

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: Needs Triage
Development

Successfully merging this pull request may close these issues.

3 participants