Skip to content

Commit 0575a26

Browse files
committed
docs: rename files to lowercase
docs: add missing events
1 parent b71bafa commit 0575a26

File tree

4 files changed

+4
-3
lines changed

4 files changed

+4
-3
lines changed
File renamed without changes.

docs/technical_documentation/concepts/event-mapping/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ Event Mapping
44
.. toctree::
55
:maxdepth: 1
66

7-
caliper_mapping
87
supported_events
8+
caliper_mapping
99
xapi_mapping

docs/technical_documentation/concepts/event-mapping/Supported_events.rst renamed to docs/technical_documentation/concepts/event-mapping/supported_events.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Video events
4242
* `edx.video.stopped`_ (legacy name: ``stop_video``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/stop_video.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.video.stopped>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/stop_video.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.video.stopped>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/stop_video.json>`__
4343
* `edx.video.paused`_ (legacy name: ``pause_video``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/pause_video.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.video.paused>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/pause_video.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.video.paused>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/pause_video.json>`__
4444
* `edx.video.position.changed`_ (legacy name: ``seek_video``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/seek_video.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.video.position.changed>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/seek_video.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.video.position.changed>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/seek_video.json>`__
45-
* complete_video | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/complete_video.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:complete_video>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/complete_video.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:complete_video>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/complete_video.json>`__
45+
* edx.video.completed (legacy name: ``complete_video``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/complete_video.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:complete_video>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/complete_video.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:complete_video>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/complete_video.json>`__
4646
* `edx.video.closed_captions.shown`_ (legacy name: ``video_show_cc_menu``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/video_show_cc_menu.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.video.closed_captions.shown>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/video_show_cc_menu.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.video.closed_captions.shown>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/video_show_cc_menu.json>`__
4747
* `edx.video.closed_captions.hidden`_ (legacy name: ``video_hide_cc_menu``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/video_hide_cc_menu.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.video.closed_captions.hidden>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/video_hide_cc_menu.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.video.closed_captions.hidden>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/video_hide_cc_menu.json>`__
4848
* `edx.video.transcript.shown`_ (legacy name: ``show_transcript``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/show_transcript.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.video.transcript.shown>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/show_transcript.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.video.transcript.shown>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/show_transcript.json>`__
@@ -52,7 +52,7 @@ Video events
5252
Course navigation events
5353
------------------------
5454

55-
* `edx.ui.lms.sequence.outline.selected`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.outline.selected.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.ui.lms.sequence.outline.selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.outline.selected.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.ui.lms.sequence.outline.selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.outline.selected.json>`__
55+
* `edx.ui.lms.sequence.outline.selected`_ (also ``edx.ui.lms.outline.selected``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.outline.selected.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.ui.lms.sequence.outline.selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.outline.selected.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.ui.lms.sequence.outline.selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.outline.selected.json>`__
5656
* `edx.ui.lms.sequence.next_selected`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.sequence.next_selected.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.ui.lms.sequence.next_selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.sequence.next_selected.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.ui.lms.sequence.next_selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.sequence.next_selected.json>`__
5757
* `edx.ui.lms.sequence.previous_selected`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.sequence.previous_selected.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.ui.lms.sequence.previous_selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.sequence.previous_selected.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.ui.lms.sequence.previous_selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.sequence.previous_selected.json>`__
5858
* `edx.ui.lms.sequence.tab_selected`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.sequence.tab_selected.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.ui.lms.sequence.tab_selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.sequence.tab_selected.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.ui.lms.sequence.tab_selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.sequence.tab_selected.json>`__
@@ -87,6 +87,7 @@ Exam events
8787
* `edx.special_exam.timed.attempt.submitted`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.special_exam.timed.attempt.submitted.json>`__ | xAPI `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.special_exam.timed.attempt.submitted.json>`__
8888
* `edx.special_exam.proctored.attempt.created`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.special_exam.proctored.attempt.created.json>`__ | xAPI `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.special_exam.proctored.attempt.created.json>`__
8989
* `edx.special_exam.proctored.attempt.submitted`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.special_exam.proctored.attempt.submitted.json>`__ | xAPI `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.special_exam.proctored.attempt.submitted.json>`__
90+
* `edx.special_exam.practice.attempt.created`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.special_exam.practice.attempt.created.json>`__ | xAPI `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.special_exam.practice.attempt.created.json>`__
9091
* `edx.special_exam.practice.attempt.submitted`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.special_exam.practice.attempt.submitted.json>`__ | xAPI `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.special_exam.practice.attempt.submitted.json>`__
9192

9293
.. _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
File renamed without changes.

0 commit comments

Comments
 (0)