Skip to content

Commit b48fe56

Browse files
committed
docs: final tweaks before review
1 parent 63a3d18 commit b48fe56

2 files changed

Lines changed: 28 additions & 10 deletions

File tree

oeps/best-practices/oep-0038-Data-Modeling.rst

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ OEP-38: Data Modeling Best Practices
88
+---------------+------------------------------------------------------------+
99
| Title | Data Modeling Best Practices |
1010
+---------------+------------------------------------------------------------+
11-
| Last Modified | 2019-09-19 |
11+
| Last Modified | 2026-03-23
1212
+---------------+------------------------------------------------------------+
1313
| Author | Brian Beggs <bbeggs@edx.org> |
1414
+---------------+------------------------------------------------------------+
@@ -316,8 +316,9 @@ Columns should store only exactly what the name describes
316316

317317
- The name of a column in a table should accurately describe the data in that table.
318318

319-
- If a column is named course_id it should only store the course_id. Not the course_key, not a numeric value, not a timestamp. Just the course_id. Conversely if a column is named course_run_key it should store the course run key, not the course_id.
320-
319+
- If a column is named course_id it should only store the course's primary key.
320+
Not a string course run key, not a UUID. For more details on naming content identifiers,
321+
see :ref:`OEP-68 Learning Content Identifiers`_.
321322

322323
Deleting data
323324
-------------
@@ -412,3 +413,18 @@ Backward Compatibility
412413
**********************
413414

414415
Data models that are not within the standards of this document do not need to be updated to adhere to OEP-38 standards.
416+
417+
Change History
418+
**************
419+
420+
2026-03-23
421+
==========
422+
423+
* Add link to :ref:`OEP-68 Learning Content Identifiers`.
424+
* `Pull request #773 <https://github.com/openedx/openedx-proposals/pull/773>`_
425+
426+
2019-05-01
427+
==========
428+
429+
* Initial proposal
430+
* `Pull request #119 <https://github.com/openedx/openedx-proposals/pull/119>`_

oeps/best-practices/oep-0068-bp-content-identifiers.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ OEP-68: Learning Content Identifiers
1111
* - Title
1212
- Learning Content Identifiers
1313
* - Last Modified
14-
- 2026-03-18
14+
- 2026-03-28
1515
* - Authors
1616
- Kyle McCormick <kyle@axim.org>
1717
* - Arbiter
@@ -21,13 +21,11 @@ OEP-68: Learning Content Identifiers
2121
* - Type
2222
- Best Practice
2323
* - Created
24-
- 2026-03-18
24+
- 2026-03-28
2525
* - Review Period
26-
- TBD
26+
- 2026-03-28 - 2026-04-13
2727
* - Resolution
2828
- TBD
29-
* - References
30-
-
3129

3230
.. contents::
3331
:local:
@@ -64,7 +62,7 @@ job matters. Here are some ways things can go wrong when the wrong kind is used:
6462
*without* mentioning X or Y by name. Otherwise the copied component in Y may erroneously
6563
try to reference media files from course run X.
6664

67-
* **Mixing version-aware and version-agnostic identifiers causes cache misses.** If
65+
* **Mixing version-aware and version-agnostic identifiers breaks lookups.** If
6866
learner-facing code queries a cache using a version-agnostic key, but cache entries were
6967
stored under version-specific keys, the cache will never be hit.
7068

@@ -356,4 +354,8 @@ Migration plan
356354
Change History
357355
**************
358356

359-
2026-03-18: Initial draft.
357+
2026-03-23
358+
==========
359+
360+
* Initial proposal
361+
* `Pull request #773 <https://github.com/openedx/openedx-proposals/pull/773>`_

0 commit comments

Comments
 (0)