openedx / openedx/code-annotations

Annotations for tracking log statements

Abierto
#180 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Python
Estrellas
5
Forks
13
Merge medio
18 h 26 min
PR fusionados (30 d)
4

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con los tipos de configuración existentes en code_annotations/contrib/config y las extensiones de Sphinx en code_annotations/contrib/sphinx/extensions. Define los requisitos de anotación para los nombres de eventos, las descripciones, los campos, los tipos y las descripciones; después, revisa la documentación de referencia de eventos enlazada y planifica la herramienta de generación de informes entre repositorios; se considera terminado cuando la documentación generada y los informes de lanzamiento puedan reemplazar la referencia de eventos manual actual.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, python
Área
documentation, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.