-
Notifications
You must be signed in to change notification settings - Fork 27
docs: add ADR for pathway catalog and content split #761
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Agrendalath
wants to merge
1
commit into
openedx:main
Choose a base branch
from
open-craft:agrendalath/pathways-adr-catalog-content-split
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+162
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
75 changes: 75 additions & 0 deletions
75
docs/openedx_learning/decisions/0004-pathway-catalog-content-split.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| .. _openedx-learning-adr-0004: | ||
|
|
||
| 4. Pathways: Split Between Catalog and Content | ||
| ============================================== | ||
|
|
||
| Status | ||
| ------ | ||
|
|
||
| Draft | ||
|
|
||
| Context | ||
| ------- | ||
|
|
||
| Courses in ``openedx-core`` already separate the *catalog* side (``openedx_catalog``: ``CatalogCourse``, | ||
| ``CourseRun`` - what learners browse and enroll against) from the *content* side (``openedx_content`` - what is | ||
| authored, versioned, and published). Pathways have the same two aspects, and the same reasons to keep them apart: | ||
|
|
||
| - **Different change rates.** The display name, description shown in the catalog, and SEO metadata are revised | ||
| frequently and casually. The definition of what a learner must do to complete the Pathway changes rarely and | ||
| deliberately. | ||
| - **Different people doing the editing.** Catalog data is typically maintained by marketing or communications staff; | ||
| the Pathway definition is maintained by content authors. Both are visible to learners, so the distinction is about | ||
| who edits what, not about who can see it. | ||
| - **Different permissions follow from that.** We expect instances to want to let marketing staff update catalog | ||
| copy without granting them the ability to change what learners must complete, and vice versa. Keeping the two | ||
| apart makes that possible without inventing field-level permissions. | ||
| - **Auditability.** Progress and credentials must be judged against the definition that was in effect at the time, | ||
| which requires versioning the definition - but versioning catalog copy would be pure overhead. | ||
|
|
||
| Decisions | ||
| --------- | ||
|
|
||
| 1. A Pathway is split into two parts: | ||
|
|
||
| - **Catalog Pathway** - the learner-browsable, enrollable thing. It includes the display name, the description | ||
| shown in the catalog, SEO metadata, and a **Category**: a student-facing label for the kind of Pathway it is | ||
| (e.g. "Master's Degree", "Annual Training"). If it is specified, learners see the Category instead of the word | ||
| "Pathway". The Catalog Pathway is **not versioned**. | ||
|
|
||
| - **Pathway content** - the definition of the Pathway: its Items and its completion criteria. The content is | ||
| **versioned**, so that we can always tell what the definition was at the moment a learner enrolled or earned a | ||
| credential. | ||
|
|
||
| 2. In authoring contexts (Studio, Django admin, code, docs), the terminology is always "Pathway", with the Category | ||
| shown explicitly. Relabelling is a learner-facing concern of the catalog side only. | ||
|
|
||
| 3. Learners enroll against the Catalog Pathway. Progress and credential evaluation run against a version of the | ||
| Pathway content. | ||
|
|
||
| Example content of each model: | ||
|
|
||
| ============================ ========================== | ||
| Catalog Pathway Pathway content | ||
| ============================ ========================== | ||
| Display name Pathway Items | ||
| Category Completion criteria | ||
| Description | ||
| SEO metadata | ||
| Enrollment | ||
| ============================ ========================== | ||
|
|
||
| .. Run `dot -Tsvg images/pathway-catalog-content.dot > images/pathway-catalog-content.svg` to regenerate the diagram | ||
| after making changes to `images/pathway-catalog-content.dot`. | ||
|
|
||
| .. image:: images/pathway-catalog-content.svg | ||
| :alt: Catalog Pathway vs versioned Pathway content | ||
| :width: 100% | ||
|
|
||
| Consequences | ||
| ------------ | ||
|
|
||
| - Catalog edits never create new content versions; definition edits (Items, criteria) always do. | ||
| - Credential and progress records can reference the exact content version in effect at the time, keeping them | ||
| auditable after the Pathway changes. | ||
| - The unversioned Catalog Pathway can be long-lived even if its content definition is changed significantly over time. | ||
21 changes: 21 additions & 0 deletions
21
docs/openedx_learning/decisions/images/pathway-catalog-content.dot
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| digraph pathway_catalog_content { | ||
| rankdir=LR; | ||
| fontname="Helvetica"; | ||
| node [shape=box, style=rounded, fontname="Helvetica", fontsize=11]; | ||
| edge [fontname="Helvetica", fontsize=10]; | ||
|
|
||
| learner [label="Learner", shape=ellipse]; | ||
| catalog [label="Catalog Pathway\n(not versioned)\nname, Category,\nmarketing, SEO"]; | ||
|
|
||
| subgraph cluster_content { | ||
| label="Pathway content (versioned)"; | ||
| fontsize=11; | ||
| style=dashed; | ||
| v1 [label="v1: Items, criteria"]; | ||
| v2 [label="v2: Items, criteria"]; | ||
| v1 -> v2 [style=dotted, label="revision"]; | ||
| } | ||
|
|
||
| learner -> catalog [label="browses / enrolls"]; | ||
| catalog -> v2 [label="current definition"]; | ||
| } |
66 changes: 66 additions & 0 deletions
66
docs/openedx_learning/decisions/images/pathway-catalog-content.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From a code point of view, I think we should always force it to be specified, and we can create a default database entry for "Pathway". If we do it with a hardcoded fallback-in-code, we're more likely to get inconsistent behaviors.