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

Improved organization of event bus specific docs #279

Open
robrap opened this issue Oct 16, 2023 · 0 comments
Open

Improved organization of event bus specific docs #279

robrap opened this issue Oct 16, 2023 · 0 comments

Comments

@robrap
Copy link
Contributor

robrap commented Oct 16, 2023

I still think it is better to have the event bus work in this repo than to have the pain of maintaining yet another repo. However, it can be confusing for some what is the difference between events in general and the event bus.

I think it is good that we have the code separated out: https://github.com/openedx/openedx-events/tree/main/openedx_events/event_bus.

However, I'm wondering if we should have a separate directory for event bus specific docs as well? Some alternatives:

  • [Option 1] Add docs/event_bus/how-tos, etc. (Simpler to add to TOC.)
  • [Option 2] Add openedx_events/event_bus/docs/how-tos, etc. (Has some pain involved, but matches OEP-19, for now.)
  • [Option 3] Leave as-is with purely event bus related docs intermingled with the rest.

Note that openedx/open-edx-proposals#530 provides more details about Option 1 and 2, especially in the linked edx-platform issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant