Commit 336ed264 by Tyler Hallada

Schedule readme: change heading hierarchy

parent 1d3ec323
......@@ -195,11 +195,13 @@ CONTACT_MAILING_ADDRESS = '<insert_physical_address_here>'
```
## Configuring Schedule Creation
## Configuration Flags
### Configuring Schedule Creation
Make sure a Site has been created at `<lms_url>/admin/sites/site`.
### ScheduleConfig
#### ScheduleConfig
In the Django admin panel at `<lms_url>/admin/schedules/scheduleconfig/` create
a ScheduleConfig and link it to the Site. Make sure to enable all of the
......@@ -210,14 +212,14 @@ settings:
* `hold_back_ratio`: ratio of all new Course Enrollments that should NOT have a
Schedule created.
### Roll-out Waffle Flag
#### Roll-out Waffle Flag
There is one roll-out related course waffle flag that we plan to delete called
`schedules.create_schedules_for_course`, which, if the
`ScheduleConfig.create_schedules` is disabled, will enable schedule creation on
a per-course basis.
### Self-paced Configuration
#### Self-paced Configuration
Schedules will only be created for a course if it is self-paced. A course can be
configured to be self-paced by going to
......@@ -227,14 +229,14 @@ Course Pacing value to "Self-Paced". Note that the Course Start Date has to be
set to sometime in the future in order to change the Course Pacing.
## Configuring Upgrade Deadline on Schedule
### Configuring Upgrade Deadline on Schedule
The upgrade reminder message type depends on there being a date in the
`upgrade_deadline` field of the Schedule model. Up-sell messaging will also be
added to the recurring nudge and course updates message types when an upgrade
deadline date is present.
### DynamicUpgradeDeadlineConfiguration models
#### DynamicUpgradeDeadlineConfiguration models
In order to enable filling in the `upgrade_deadline` field of new Schedule
models created, you must create and enable one of the following:
......@@ -253,17 +255,16 @@ DynamicUpgradeDeadlineConfiguration.
The "deadline days" field specifies how many days from the day of the learner's
enrollment will be their soft upgrade deadline on the Schedule model.
### Verified Course Mode
#### Verified Course Mode
The `upgrade_deadline` will only be filled for a course if it has a verified
course mode. To add a verified course mode to a course, go to
`<lms_url>/admin/course_modes/coursemode/` and add a course mode linked with
the course with the "Mode" equal to "verified".
### Configuring Email Sending
## Configuring Email Sending
### ScheduleConfig
#### ScheduleConfig
The ScheduleConfig model at `<lms_url>/admin/schedules/scheduleconfig/` also has
fields which configure enqueueing and delivering emails per message type:
......@@ -271,14 +272,14 @@ fields which configure enqueueing and delivering emails per message type:
* `enqueue_*`: allows sending email tasks of this message type to celery.
* `deliver_*`: allows delivering emails through ACE for this message type.
### Roll-out Waffle Flag
#### Roll-out Waffle Flag
Another roll-out related course waffle flag that we plan to delete called
`schedules.send_updates_for_course` will enable sending specifically the course
updates email per-course.
## Configuring Highlights UI in Studio
### Configuring Highlights UI in Studio
The button and modal on the course outline page that allows course authors to
enter section highlights can be toggled globally by going to
......@@ -288,25 +289,25 @@ enter section highlights can be toggled globally by going to
This is a roll-out related waffle switch that we will eventually delete.
## Configuring a Learner's Schedule
### Configuring a Learner's Schedule
Emails will only be sent to learners who have Schedule `start_date`s or
`upgrade_deadline`s and ScheduleExperience that match the criteria for the
message type.
### Recurring Nudge
#### Recurring Nudge
* Learners must have the ScheduleExperience type of "Recurring Nudge and Upgrade
Reminder".
* Their Schedule `start_date` must be 3 or 10 days before the current date.
### Upgrade Reminder
#### Upgrade Reminder
* Learners must have the ScheduleExperience type of "Recurring Nudge and Upgrade
Reminder".
* Their Schedule `upgrade_deadline` must be 2 days after the current date.
### Course Update
#### Course Update
* Learners must have the ScheduleExperience type of "Course Updates".
* Their Schedule `start_date` must be 7, 14, or any increment of 7 days up to 77
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment