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

Improve docs for when and how to add events #269

Open
robrap opened this issue Sep 20, 2023 · 1 comment
Open

Improve docs for when and how to add events #269

robrap opened this issue Sep 20, 2023 · 1 comment

Comments

@robrap
Copy link
Contributor

robrap commented Sep 20, 2023

This would likely affect:
https://docs.openedx.org/projects/openedx-events/en/latest/how-tos/creating-new-events.html

A quote from someone about something that wasn't obvious from the docs:

I think what I’m hearing is let’s not be stingy about creating new events even if it only has one use today

I think it would be great to clarify that events that only serve a single use case (to start) is not only completely acceptable, but the most common situation. That said, thinking about future consumers might help influence the event design, so it is useful to consider as well.

@robrap
Copy link
Contributor Author

robrap commented Sep 20, 2023

@Zacharis278: You mentioned "best practices", but I think it is difficult to start from something so general. If you have specifics about things you learned, or questions you have, I think it would be great to capture them on this ticket, and eventually in the docs. Thank you!

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