Commit 0df10b36 by Greg Price Committed by Zia Fazal

fixup! Add documentation for cohort events

Reword description of auto vs. manual creation of cohorts and user
addition to cohorts.
parent 820e1a10
...@@ -2179,10 +2179,12 @@ Student Cohort Events ...@@ -2179,10 +2179,12 @@ Student Cohort Events
``edx.cohort.created`` ``edx.cohort.created``
---------------------------------- ----------------------------------
When a cohort group is created (either automatically, when a user is assigned to When a cohort group is created, the server emits an ``edx.cohort.created``
the default cohort group or a cohort group included in the course's event. A member of the course staff can create a cohort group manually via the
``auto_cohort_groups`` setting, or manually, via the Instructor Dashboard), the Instructor Dashboard (see :ref:`instructor_cohort_events`). The system
server emits an ``edx.cohort.created`` event. automatically creates the default cohort group and cohort groups included in the
course's ``auto_cohort_groups`` setting as they are needed (e.g. when a student
is assigned to one).
**Event Source**: Server **Event Source**: Server
...@@ -2207,10 +2209,13 @@ server emits an ``edx.cohort.created`` event. ...@@ -2207,10 +2209,13 @@ server emits an ``edx.cohort.created`` event.
``edx.cohort.user_added`` ``edx.cohort.user_added``
---------------------------------- ----------------------------------
When a user is added to a cohort group (either automatically, when a user is When a user is added to a cohort group, the server emits an
assigned to the default cohort group or a cohort group included in the course's ``edx.cohort.user_added`` event. A member of the course staff can add a user to
``auto_cohort_groups`` setting, or manually, via the Instructor Dashboard), the a cohort group manually via the Instructor Dashboard (see
server emits an ``edx.cohort.user_added`` event. :ref:`instructor_cohort_events`). The system automatically adds a user to the default
cohort group or a cohort group included in the course's ``auto_cohort_groups``
setting if the user accesses a discussion but has not yet been assigned to a
cohort group.
**Event Source**: Server **Event Source**: Server
......
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