openedx / openedx/code-annotations
Annotations for tracking log statements
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 5
- Forks
- 13
- Ø Merge
- 18 Std. 26 Min.
- Gemergte PRs (30 T.)
- 4
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit den vorhandenen Konfigurationstypen unter code_annotations/contrib/config und den Sphinx-Erweiterungen unter code_annotations/contrib/sphinx/extensions. Definiere die Anforderungen an Annotationen für Ereignisnamen, Beschreibungen, Felder, Typen und Beschreibungen, überprüfe anschließend die verlinkte Dokumentation zur Ereignisreferenz und plane das repositoryübergreifende Berichtstool; als abgeschlossen gilt die Arbeit, wenn generierte Dokumentation und Release-Berichte die aktuelle manuelle Ereignisreferenz ersetzen können.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, python
- Bereich
- documentation, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100