openedx / openedx/code-annotations
Annotations for tracking log statements
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 5
- Fork
- 13
- Merge medio
- 18h 26m
- PR unite (30g)
- 4
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia con i tipi di configurazione esistenti in code_annotations/contrib/config e le estensioni Sphinx in code_annotations/contrib/sphinx/extensions. Definisci i requisiti delle annotazioni per i nomi degli eventi, le descrizioni, i campi, i tipi e le descrizioni, quindi esamina la documentazione di riferimento agli eventi collegata e pianifica lo strumento di reporting tra repository; il lavoro è completo quando la documentazione generata e i report di release possono sostituire l’attuale riferimento manuale agli eventi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, python
- Ambito
- documentation, tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100