openedx / openedx/frontend-app-authoring
[Draft Story] Associate metadata with tags
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 17
- Forks
- 218
- Avg merge
- 9d 20h
- Merged PRs (30d)
- 20
Description
[Note: This story is a work-in-progress. It needs further refinement, including the more end-user data/pain points, and a more detailed spec.]
Value Proposition/Use Cases
Up to this point, the development of the MVP for the platform's tagging function has focused on the association of content with tags. Course authors can add tags to content (courses, sections, units, lessons, modules). Tags come from structured taxonomies and are defined and managed at the platform or organization level. This has enabled use cases such as being able to associate a lesson or a course with a particular learning outcome, competency or subject.
In future phases of tagging rollout, we want to explore the ability to associate metadata to tags. This expansion is a critical step toward a more full-bodied realization of competency-based learning pathways. It will enable a varied range of use cases, such as:
Adding a description to a tag
- "As an instructional designer, I want to see more information about the tags that I am adding to learning sequences, so I can be sure I am associating the right content to the right outcomes."
- "As an employer who is evaluating competencies listed on a candidate's resume, I need to better understand what the candidate is able to do as a result of the competency she has listed, so I can ascertain whether the competency is relevant to the job responsibilities."
Adding a job code to a tag
- "As a curriculum designer, I am trying to ensure that the competencies I am connecting to course content actually align to the skills required for a particular job, and I'd like a way to associate a job code from a third-party skills taxonomy to my department's competency taxonomy."
Associate learning analytics to a tag
"As an instructor, I'd like to be able to drill down to any level of my taxonomy and get associated engagement data for content with that tag."
General Requirements:
- The platform supports a generic ability for a metadata field to be associated with a tag.
- Metadata fields can be free-text fields.
- Metadata fields are visible next to the tags they are associated with in the Taxonomy Landing page.
- It is easy to add metadata fields to tags via the csv bulk upload or via in-platform taxonomy editing.
- The metadata field is extensible and can pull in associated event data.
Acceptance Criteria:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing tagging and taxonomy flows, especially the Taxonomy Landing page, CSV bulk upload, and in-platform taxonomy editing. Refine the use cases and acceptance criteria into a detailed specification covering generic and free-text metadata, visibility, editing, and extensibility. Done means the requirements are agreed and specific enough to guide implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- content, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100