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

Cross-repo collection of all events in the ecosystem #366

Open
Tracked by #358
mariajgrimaldi opened this issue Jun 24, 2024 · 0 comments
Open
Tracked by #358

Cross-repo collection of all events in the ecosystem #366

mariajgrimaldi opened this issue Jun 24, 2024 · 0 comments
Labels
documentation Relates to documentation improvements

Comments

@mariajgrimaldi
Copy link
Member

mariajgrimaldi commented Jun 24, 2024

Description

Some comments I've gathered from the community survey on the challenges/suggestions section:

I wish it was easier to see the named release when each event/filter was added. It would also be helpful to know which Open edX services an event or filter is used in (edx-platform, credentials, etc.).

Finding a comprehensive list of events/filters (especially those outside of edx-platform) is challenging, and they are not all well documented. I added autodoc support for events, but there is probably more work to be done there.
More clarity about which events are event-bus capable and the differences between bus and non-bus events would also be great.

A cross-repo collection of all events / filters in the ecosystem. It would be great to have a consistent way to access permissions inside a filter. This has been a point of confusion in the instructor dashboard filter around where permissions are / should be checked.

@mariajgrimaldi mariajgrimaldi changed the title Documentation: cross-repo collection of all events in the ecosystem Cross-repo collection of all events in the ecosystem Jun 24, 2024
@mariajgrimaldi mariajgrimaldi added documentation Relates to documentation improvements maintenance Routine upkeep necessary for the health of the platform and removed maintenance Routine upkeep necessary for the health of the platform labels Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to documentation improvements
Projects
None yet
Development

No branches or pull requests

1 participant