Skip to content

Commit 944808e

Browse files
committed
chore: address pr review
- Rename Django setting - Rename tracking model
1 parent 818a444 commit 944808e

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

docs/decisions/0013-course-authoring-automatic-migration.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ Currently, migrations between both systems are performed manually using Django m
1818
- ``authz_rollback_course_authoring`` (rollback migration)
1919

2020
In `ADR 0011`_ and `ADR 0010`_ it was established that migration must occur automatically when
21-
the feature flag ``authz.enable_course_authoring`` changes state, but they deferred the definition of
22-
the specific mechanism. This ADR addresses that gap.
21+
the feature flag ``authz.enable_course_authoring`` changes state, but the definition of
22+
the specific mechanism was deferred. This ADR addresses that gap.
2323

2424
The current manual approach presents the following risks:
2525

@@ -70,7 +70,7 @@ To address this, the automatic migration mechanism will be **guarded by a Django
7070

7171
.. code:: python
7272
73-
ENABLE_AUTOMATIC_COURSE_AUTHORING_MIGRATION = False
73+
ENABLE_AUTOMATIC_AUTHZ_COURSE_AUTHORING_MIGRATION = False
7474
7575
This setting:
7676

@@ -123,7 +123,7 @@ A new model is introduced to track the lifecycle of each migration operation:
123123

124124
.. code:: python
125125
126-
class CourseAuthoringMigrationRun(models.Model):
126+
class AuthzCourseAuthoringMigrationRun(models.Model):
127127
migration_type = models.CharField(max_length=20) # forward / rollback
128128
scope_type = models.CharField(max_length=20) # course / org
129129
scope_key = models.CharField(max_length=255)
@@ -169,8 +169,8 @@ migration runs at a time for the same scope.
169169
2. The ``pre_save`` signal handler detects the state transition.
170170
3. A Celery task is dispatched asynchronously.
171171
4. The task calls the utility function, which acquires the lock, creates and updates the
172-
``CourseAuthoringMigrationRun`` record, and executes the migration.
173-
5. The operator can check the migration status via Django Admin on the ``CourseAuthoringMigrationRun``
172+
``AuthzCourseAuthoringMigrationRun`` record, and executes the migration.
173+
5. The operator can check the migration status via Django Admin on the ``AuthzCourseAuthoringMigrationRun``
174174
model.
175175

176176
Consequences

0 commit comments

Comments
 (0)