From 0575a26391ecb13075d8dcf4cca60d2f45bd948e Mon Sep 17 00:00:00 2001 From: Sara Burns Date: Mon, 17 Nov 2025 11:19:12 -0500 Subject: [PATCH 1/2] docs: rename files to lowercase docs: add missing events --- .../{Caliper_mapping.rst => caliper_mapping.rst} | 0 .../technical_documentation/concepts/event-mapping/index.rst | 2 +- .../{Supported_events.rst => supported_events.rst} | 5 +++-- .../event-mapping/{xAPI_mapping.rst => xapi_mapping.rst} | 0 4 files changed, 4 insertions(+), 3 deletions(-) rename docs/technical_documentation/concepts/event-mapping/{Caliper_mapping.rst => caliper_mapping.rst} (100%) rename docs/technical_documentation/concepts/event-mapping/{Supported_events.rst => supported_events.rst} (95%) rename docs/technical_documentation/concepts/event-mapping/{xAPI_mapping.rst => xapi_mapping.rst} (100%) diff --git a/docs/technical_documentation/concepts/event-mapping/Caliper_mapping.rst b/docs/technical_documentation/concepts/event-mapping/caliper_mapping.rst similarity index 100% rename from docs/technical_documentation/concepts/event-mapping/Caliper_mapping.rst rename to docs/technical_documentation/concepts/event-mapping/caliper_mapping.rst diff --git a/docs/technical_documentation/concepts/event-mapping/index.rst b/docs/technical_documentation/concepts/event-mapping/index.rst index 25c047e4..4142e300 100644 --- a/docs/technical_documentation/concepts/event-mapping/index.rst +++ b/docs/technical_documentation/concepts/event-mapping/index.rst @@ -4,6 +4,6 @@ Event Mapping .. toctree:: :maxdepth: 1 - caliper_mapping supported_events + caliper_mapping xapi_mapping diff --git a/docs/technical_documentation/concepts/event-mapping/Supported_events.rst b/docs/technical_documentation/concepts/event-mapping/supported_events.rst similarity index 95% rename from docs/technical_documentation/concepts/event-mapping/Supported_events.rst rename to docs/technical_documentation/concepts/event-mapping/supported_events.rst index c054df22..f7456d83 100644 --- a/docs/technical_documentation/concepts/event-mapping/Supported_events.rst +++ b/docs/technical_documentation/concepts/event-mapping/supported_events.rst @@ -42,7 +42,7 @@ Video events * `edx.video.stopped`_ (legacy name: ``stop_video``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ * `edx.video.paused`_ (legacy name: ``pause_video``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ * `edx.video.position.changed`_ (legacy name: ``seek_video``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* complete_video | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* edx.video.completed (legacy name: ``complete_video``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ * `edx.video.closed_captions.shown`_ (legacy name: ``video_show_cc_menu``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ * `edx.video.closed_captions.hidden`_ (legacy name: ``video_hide_cc_menu``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ * `edx.video.transcript.shown`_ (legacy name: ``show_transcript``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ @@ -52,7 +52,7 @@ Video events Course navigation events ------------------------ -* `edx.ui.lms.sequence.outline.selected`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.ui.lms.sequence.outline.selected`_ (also ``edx.ui.lms.outline.selected``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ * `edx.ui.lms.sequence.next_selected`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ * `edx.ui.lms.sequence.previous_selected`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ * `edx.ui.lms.sequence.tab_selected`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ @@ -87,6 +87,7 @@ Exam events * `edx.special_exam.timed.attempt.submitted`_ | edX `sample `__ | xAPI `sample `__ * `edx.special_exam.proctored.attempt.created`_ | edX `sample `__ | xAPI `sample `__ * `edx.special_exam.proctored.attempt.submitted`_ | edX `sample `__ | xAPI `sample `__ +* `edx.special_exam.practice.attempt.created`_ | edX `sample `__ | xAPI `sample `__ * `edx.special_exam.practice.attempt.submitted`_ | edX `sample `__ | xAPI `sample `__ .. _edx.course.enrollment.activated: https://docs.openedx.org/en/latest/developers/references/internal_data_formats/tracking_logs/student_event_types.html#edx-course-enrollment-activated-and-edx-course-enrollment-deactivated diff --git a/docs/technical_documentation/concepts/event-mapping/xAPI_mapping.rst b/docs/technical_documentation/concepts/event-mapping/xapi_mapping.rst similarity index 100% rename from docs/technical_documentation/concepts/event-mapping/xAPI_mapping.rst rename to docs/technical_documentation/concepts/event-mapping/xapi_mapping.rst From ade4e9c7f368e3c9ab8306e4c3e99f220578d9d9 Mon Sep 17 00:00:00 2001 From: Sara Burns Date: Tue, 18 Nov 2025 13:21:08 -0500 Subject: [PATCH 2/2] docs: change to Open edX --- .../event-mapping/supported_events.rst | 108 +++++++++--------- 1 file changed, 54 insertions(+), 54 deletions(-) diff --git a/docs/technical_documentation/concepts/event-mapping/supported_events.rst b/docs/technical_documentation/concepts/event-mapping/supported_events.rst index f7456d83..2073927a 100644 --- a/docs/technical_documentation/concepts/event-mapping/supported_events.rst +++ b/docs/technical_documentation/concepts/event-mapping/supported_events.rst @@ -7,88 +7,88 @@ edX events supported by ``event-routing-backends`` are listed below. Enrollment events ----------------- -* `edx.course.enrollment.activated`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.course.enrollment.deactivated`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.course.enrollment.mode_changed`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.course.enrollment.activated`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.course.enrollment.deactivated`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.course.enrollment.mode_changed`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ Course grading events ----------------------- -* `edx.course.grade.passed.first_time`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.course.grade.now_passed`_ | edX `sample `__ | xAPI `sample `__ -* `edx.course.grade.now_failed`_ | edX `sample `__ | xAPI `sample `__ | Caliper `sample `__ -* `edx.grades.subsection.grade_calculated`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.grades.course.grade_calculated`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.course.grade.passed.first_time`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.course.grade.now_passed`_ | Open edX `sample `__ | xAPI `sample `__ +* `edx.course.grade.now_failed`_ | Open edX `sample `__ | xAPI `sample `__ | Caliper `sample `__ +* `edx.grades.subsection.grade_calculated`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.grades.course.grade_calculated`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ Completion events ----------------- -* `edx.completion.block_completion.changed`_ | edX `sample `__ | xAPI `sample `__ +* `edx.completion.block_completion.changed`_ | Open edX `sample `__ | xAPI `sample `__ Problem interaction events --------------------------- -* `problem_check`_ with ``event_source`` as ``server`` | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `problem_check`_ with ``event_source`` as ``browser`` | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `showanswer`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.problem.hint.demandhint_displayed`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.grades.problem.submitted`_ | edX `sample `__ | xAPI `sample `__ +* `problem_check`_ with ``event_source`` as ``server`` | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `problem_check`_ with ``event_source`` as ``browser`` | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `showanswer`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.problem.hint.demandhint_displayed`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.grades.problem.submitted`_ | Open edX `sample `__ | xAPI `sample `__ Video events ------------- -* `edx.video.loaded`_ (legacy name: ``load_video``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.video.played`_ (legacy name: ``play_video``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.video.stopped`_ (legacy name: ``stop_video``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.video.paused`_ (legacy name: ``pause_video``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.video.position.changed`_ (legacy name: ``seek_video``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* edx.video.completed (legacy name: ``complete_video``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.video.closed_captions.shown`_ (legacy name: ``video_show_cc_menu``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.video.closed_captions.hidden`_ (legacy name: ``video_hide_cc_menu``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.video.transcript.shown`_ (legacy name: ``show_transcript``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.video.transcript.hidden`_ (legacy name: ``hide_transcript``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `speed_change_video`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.video.loaded`_ (legacy name: ``load_video``) | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.video.played`_ (legacy name: ``play_video``) | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.video.stopped`_ (legacy name: ``stop_video``) | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.video.paused`_ (legacy name: ``pause_video``) | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.video.position.changed`_ (legacy name: ``seek_video``) | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* edx.video.completed (legacy name: ``complete_video``) | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.video.closed_captions.shown`_ (legacy name: ``video_show_cc_menu``) | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.video.closed_captions.hidden`_ (legacy name: ``video_hide_cc_menu``) | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.video.transcript.shown`_ (legacy name: ``show_transcript``) | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.video.transcript.hidden`_ (legacy name: ``hide_transcript``) | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `speed_change_video`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ Course navigation events ------------------------ -* `edx.ui.lms.sequence.outline.selected`_ (also ``edx.ui.lms.outline.selected``) | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.ui.lms.sequence.next_selected`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.ui.lms.sequence.previous_selected`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.ui.lms.sequence.tab_selected`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ -* `edx.ui.lms.link_clicked`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.ui.lms.sequence.outline.selected`_ (also ``edx.ui.lms.outline.selected``) | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.ui.lms.sequence.next_selected`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.ui.lms.sequence.previous_selected`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.ui.lms.sequence.tab_selected`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ +* `edx.ui.lms.link_clicked`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ | Caliper :ref:`map `, `sample `__ Forum events ----------------- -* `edx.forum.thread.created`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.thread.edited`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.thread.viewed`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.thread.deleted`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.thread.voted`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.thread.reported`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.thread.unreported`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.response.created`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.response.edited`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.response.deleted`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.response.voted`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.response.reported`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.response.unreported`_ | edX `sample `__ | xAPI :ref:`map `, `sample `__ -* `edx.forum.comment.created`_ | edX `sample `__ | xAPI `sample `__ -* `edx.forum.comment.edited`_ | edX `sample `__ | xAPI `sample `__ -* `edx.forum.comment.deleted`_ | edX `sample `__ | xAPI `sample `__ -* `edx.forum.comment.reported`_ | edX `sample `__ | xAPI `sample `__ -* `edx.forum.comment.unreported`_ | edX `sample `__ | xAPI `sample `__ +* `edx.forum.thread.created`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.thread.edited`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.thread.viewed`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.thread.deleted`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.thread.voted`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.thread.reported`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.thread.unreported`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.response.created`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.response.edited`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.response.deleted`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.response.voted`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.response.reported`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.response.unreported`_ | Open edX `sample `__ | xAPI :ref:`map `, `sample `__ +* `edx.forum.comment.created`_ | Open edX `sample `__ | xAPI `sample `__ +* `edx.forum.comment.edited`_ | Open edX `sample `__ | xAPI `sample `__ +* `edx.forum.comment.deleted`_ | Open edX `sample `__ | xAPI `sample `__ +* `edx.forum.comment.reported`_ | Open edX `sample `__ | xAPI `sample `__ +* `edx.forum.comment.unreported`_ | Open edX `sample `__ | xAPI `sample `__ Exam events ------------------ -* `edx.special_exam.timed.attempt.created`_ | edX `sample `__ | xAPI `sample `__ -* `edx.special_exam.timed.attempt.submitted`_ | edX `sample `__ | xAPI `sample `__ -* `edx.special_exam.proctored.attempt.created`_ | edX `sample `__ | xAPI `sample `__ -* `edx.special_exam.proctored.attempt.submitted`_ | edX `sample `__ | xAPI `sample `__ -* `edx.special_exam.practice.attempt.created`_ | edX `sample `__ | xAPI `sample `__ -* `edx.special_exam.practice.attempt.submitted`_ | edX `sample `__ | xAPI `sample `__ +* `edx.special_exam.timed.attempt.created`_ | Open edX `sample `__ | xAPI `sample `__ +* `edx.special_exam.timed.attempt.submitted`_ | Open edX `sample `__ | xAPI `sample `__ +* `edx.special_exam.proctored.attempt.created`_ | Open edX `sample `__ | xAPI `sample `__ +* `edx.special_exam.proctored.attempt.submitted`_ | Open edX `sample `__ | xAPI `sample `__ +* `edx.special_exam.practice.attempt.created`_ | Open edX `sample `__ | xAPI `sample `__ +* `edx.special_exam.practice.attempt.submitted`_ | Open edX `sample `__ | xAPI `sample `__ .. _edx.course.enrollment.activated: https://docs.openedx.org/en/latest/developers/references/internal_data_formats/tracking_logs/student_event_types.html#edx-course-enrollment-activated-and-edx-course-enrollment-deactivated .. _edx.course.enrollment.deactivated: https://docs.openedx.org/en/latest/developers/references/internal_data_formats/tracking_logs/student_event_types.html#edx-course-enrollment-activated-and-edx-course-enrollment-deactivated