openedx / openedx/code-annotations
Annotations for tracking log statements
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 5
- Fork
- 13
- Merge trung bình
- 18 giờ 26 phút
- Pull request đã merge (30 ngày)
- 4
Mô tả
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
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với các kiểu cấu hình hiện có trong code_annotations/contrib/config và các phần mở rộng Sphinx trong code_annotations/contrib/sphinx/extensions. Xác định các yêu cầu chú thích cho tên sự kiện, mô tả, trường, kiểu và mô tả, sau đó xem xét tài liệu tham chiếu sự kiện được liên kết và lập kế hoạch cho công cụ báo cáo xuyên kho lưu trữ; được xem là hoàn thành khi tài liệu được tạo và các báo cáo release có thể thay thế tài liệu tham chiếu sự kiện thủ công hiện tại.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- javascript, python
- Lĩnh vực
- documentation, tooling
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 25/100