mitodl / mitodl/mit-learn

Assign a LearningResourceDepartment, LearningResourceDLC to resources when appropriate

Open
#95 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
3
Forks
4
Avg merge
2d 3h
Merged PRs (30d)
114

Description

User Story

As a podcast listener, I would like to know which MIT Department (or DLC - Lab/Center/Institute), if any, produces each podcast.
Ditto for other learning resources where applicable.

Description/Context

  • Create a new LearningResourceDLC class with fields like name and maybe dlc_id, url - similar to LearningResourceDepartment. Add to LearningResource class as a nullable field (dlc?) via foreign key.
  • Assign department and/or DLC (if any) as part of the ETL process - extract from the catalog API response if present.

Acceptance Criteria

  • The yaml files for podcasts have fields for offered_by, department, and dlc where applicable
  • LearningResources will have a non-null department and DLC where applicable

Plan/Design

  • Create a new LearningResourceDLC class with fields like name and maybe dlc_id, url - similar to LearningResourceDepartment. Add to LearningResource class as a nullable field (dlc?) via foreign key.
  • Assign department and/or DLC where applicable as part of the ETL process - extract from the catalog API response if present.
  • Update the podcast yaml files to include fields for offered_by, department, and dlc where applicable
  • Out of scope (issue per app): update each online app's catalog API response to include these field where applicable, otherwise they will be assumed to be null.

Contributor guide

No contributing guide indexed for this repository

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 locating LearningResourceDepartment, LearningResource, and the ETL pipeline, then inspect the catalog API response fields available for departments and DLCs. Review the podcast YAML files and determine how offered_by, department, and dlc should be represented. Done means applicable resources have department and DLC data, and the acceptance criteria are met without changing the online apps.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, yaml
Domain
backend, data-engineering, databases
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.