openedx / openedx/code-annotations

Annotations for tracking log statements

Ouverte
#180 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
5
Forks
13
Merge moyen
18 h 26 min
PR mergées (30 j)
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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par les types de configuration existants dans code_annotations/contrib/config et les extensions Sphinx dans code_annotations/contrib/sphinx/extensions. Définissez les exigences d’annotation pour les noms d’événements, les descriptions, les champs, les types et les descriptions, puis examinez la documentation de référence des événements liée et planifiez l’outil de génération de rapports inter-dépôts ; le travail est considéré comme terminé lorsque la documentation générée et les rapports de release peuvent remplacer la référence manuelle actuelle des événements.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, python
Domaine
documentation, tooling
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.