openedx / openedx/code-annotations
Annotations for tracking log statements
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 13
- Avg merge
- 18h 26m
- Merged PRs (30d)
- 4
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing config types under code_annotations/contrib/config and Sphinx extensions under code_annotations/contrib/sphinx/extensions. Define the annotation requirements for event names, descriptions, fields, types, and descriptions, then review the linked event-reference documentation and plan the cross-repository reporting tool; done means generated documentation and release reports can replace the current manual event reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, python
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100