openedx / openedx/openedx-platform

Audit & document tracking events for ProblemBank

Open
#38,031 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.2k
Forks
4.4k
Avg merge
6d 18h
Merged PRs (30d)
42

Description

Context

The old randomized Legacy Library component (LegacyLibraryContentBlock) emits events with the prefix edx.librarycontentblock.content.

The new Problem Bank component (ItemBankBlock) the same events, but with the prefix edx.itembankblock.content.

The eventing docs have not been updated yet: https://docs.openedx.org/en/latest/developers/references/internal_data_formats/tracking_logs/student_event_types.html#content-library-interaction-events

AC

  • Confirm that the Problem Bank events correspond to the old Legacy Library block events
    • If not, fix them
  • Document edx.itembankblock.content. (could be interleaved with edx.librarycontentblock.content.documentation if that's easier). Mention that the edx.librarycontentblock.content. events are for a deprecated block.
  • Add a note to https://docs.openedx.org/en/latest/educators/how-tos/course_development/migrate_legacy_libraries.html that event names will change when converting a legacy Libraries block into a Problem Bank
  • Backport to Ulmo

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the LegacyLibraryContentBlock and ItemBankBlock tracking events against the linked student event types documentation. Update that eventing page and the legacy-library migration guide to document the new prefix, identify the deprecated prefix, and note the conversion change. Confirm any mismatches are fixed and backport the completed documentation to Ulmo.

Written by the indexing model from the issue text.

Assessment

Domain
analytics, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.