openedx / openedx/code-annotations
Annotations for tracking log statements
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 5
- 派生
- 13
- 平均合并
- 18 小时 26 分钟
- 30 天内合并 PR
- 4
描述
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
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 code_annotations/contrib/config 下现有的配置类型以及 code_annotations/contrib/sphinx/extensions 下的 Sphinx 扩展开始。定义事件名称、描述、字段、类型和描述的注解要求,然后审查链接的事件参考文档并规划跨仓库报告工具;当生成的文档和发布报告能够替代当前手动维护的事件参考时,即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript, python
- 领域
- documentation, tooling
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100