-
Notifications
You must be signed in to change notification settings - Fork 11
Open
Description
We should add annotations for both Python and Javascript tracking log statements so that we can generate reports between releases to document which events have been added / removed / changed, where they are being emitted from, and confirm that those changes do not break downstream reporting.
We should at least include the event name and description thought it would be ideal to capture the fields, types, and descriptions so that we can automatically create documentation like we have been doing manually:
https://docs.openedx.org/en/latest/developers/references/internal_data_formats/tracking_logs/student_event_types.html
This would involve:
- Adding a new config type for tracking events
- Adding a new Sphinx extension to render the documentation
- Updating docs.openedx.org to use the new documentation to replace the event reference
- Creating a tool to generate reports across repositories in the openedx org
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
Ready for Work