GitHub PullRequestReviewCommentEvent at 2014-10-02 16:15:46
Repository: edx-platform
Actor: cahrens
Payload: {"action":"created","comment":{"url":"https://api.github.com/repos/edx/edx-platform/pulls/comments/18349300","id":18349300,"diff_hunk":"@@ -0,0 +1,286 @@\n+.. _Enabling and Configuring Cohorts:\n+\n+############################################\n+Enabling and Configuring the Cohort Feature\n+############################################\n+\n+To support private discussions for cohorts of students, you select a strategy\n+for assigning your students to cohort groups: automated assignment, manual\n+assignment, or a hybrid approach. See :ref:`Options for Assigning Students to\n+Cohorts`. You also decide whether to change any of the course-wide discussion\n+topics to support private interactions among the members of the cohort groups. \n+\n+After you select a strategy, you complete these steps (as applicable):\n+\n+#. :ref:`Enable the cohort feature<Enable Cohorts>`.\n+\n+#. Based on the strategy you select for assigning students to cohort groups:\n+   \n+  * :ref:`Define the auto cohort groups<Define Auto Cohort Groups>`.\n+\n+  * :ref:`Define the manual cohort groups<Define the Manual Cohort Groups>` and\n+    then :ref:`assign students to them<Assign Students to Cohort Groups\n+    Manually>`.\n+\n+  * Do both. \n+\n+3. :ref:`Identify the course-wide discussion topics<Identifying Private\n+   CourseWide Discussion Topics>` that you want to support private, cohort-only\n+   participation. This procedure is optional.\n+\n+You complete these procedures in Studio and on the Instructor Dashboard. For an\n+optimal student experience, configuration of the cohort feature should be as\n+complete as possible prior to the start date of your course.\n+\n+.. _Enable Cohorts:\n+\n+********************************\n+Enabling the Cohort Feature\n+********************************\n+\n+#. Open the course in Studio. \n+\n+#. Select **Settings**, then **Advanced Settings**.\n+\n+#. In the **Cohort Configuration** field, place your cursor between the\n+   supplied pair of braces.\n+\n+#. Type ``\"cohorted\": true``. \n+\n+#. Click **Save Changes**. Studio reformats the name:value pair you just\n+   entered to indent it on a new line.\n+   \n+ .. image:: ../Images/Enable_cohorts.png\n+  :alt: Cohort Configuration dictionary field with the cohorted key defined \n+        as true\n+\n+You can then :ref:`implement the automated assignment strategy<Implementing the\n+Automated Assignment Strategy>`, :ref:`implement the manual assignment\n+strategy<Implementing the Manual Assignment Strategy>`, or both.\n+\n+.. _Implementing the Automated Assignment Strategy:\n+\n+***************************************************\n+Implementing the Automated Assignment Strategy\n+***************************************************\n+\n+To implement automated assignment of students to cohort groups you define the\n+auto cohort groups in the **Cohort Configuration** advanced setting field.\n+\n+You complete this procedure if you are using either the automated or hybrid\n+assignment strategy for your course. For more information, see :ref:`All\n+Automated Assignment` or :ref:`Hybrid Assignment`.\n+\n+.. _Define Auto Cohort Groups:\n+\n+============================================\n+Define the Auto Cohort Groups\n+============================================\n+\n+.. note:: Students can see the name of the cohort group they are assigned to. \n+ The message \"This post is visible only to Group *cohort name*\" appears with\n+ each post in discussion topics that support private, cohort-only\n+ participation.\n+\n+#. Open the course in Studio. \n+\n+#. Select **Settings**, then **Advanced Settings**.\n+\n+#. In the **Cohort Configuration** field, place your cursor after the opening\n+   brace character (``{``) and press Enter.\n+\n+#. On the new line, you define the ``\"auto_cohort_groups\": `` policy key,\n+   followed by one or more cohort group names enclosed by square brackets (``[\n+   ]``). You can define a set of auto cohort groups or just one.\n+\n+   To define a set of groups, you type each group name on a new line, enclose\n+   it within quotation marks (``\" \"``), and separate the quoted name values\n+   with commas. For example:\n+   \n+ .. code:: \n+\n+   \"auto_cohort_groups\": [\n+       \"Example Group Name A\",\n+       \"Example Group Name B\",\n+       \"Example Group Name C\"\n+   ]\n+   \n+.. comment is here only to allow indented formatting of next line\n+\n+  You can also define only a single auto cohort group. Type\n+   ``\"auto_cohort_groups\": [\"Example Group Name\"]`` and then press Enter again.\n+\n+5. Type a comma after the closing square bracket character (``],``). You must\n+   include a comma to separate each of the policy keys that you define.\n+   \n+#. Click **Save Changes**. Studio resequences and reformats your entry. Scroll\n+   back to the **Cohort Configuration** field to assure that your entry was\n+   saved. Entries that do not contain all of the required punctuation\n+   characters are not saved.\n+\n+ .. image:: ../Images/Multiple_auto_cohort_groups.png\n+  :alt: Cohort Configuration dictionary field with the auto_cohort_groups key \n+        with three values\n+\n+.. spacer line\n+\n+ .. image:: ../Images/Single_auto_cohort_group.png\n+  :alt: Cohort Configuration dictionary field with the auto_cohort_groups key \n+        with one value\n+\n+Any student who is not already assigned to a cohort group will be randomly\n+assigned to one of the auto cohort groups you defined.\n+\n+For a report that includes the cohort group assignment for every enrolled\n+student, review the student profile information for your course. See\n+:ref:`View and download student data`.\n+\n+.. _Implementing the Manual Assignment Strategy:\n+\n+***************************************************\n+Implementing the Manual Assignment Strategy\n+***************************************************\n+\n+To implement manual assignment of students to cohort groups, you define the\n+manual cohort groups and then assign students to them. \n+\n+You complete these procedures if you are using either the manual or hybrid\n+assignment strategy for your course. For more information, see :ref:`All Manual\n+Assignment` or :ref:`Hybrid Assignment`.\n+\n+You must :ref:`enable the cohort feature<Enable Cohorts>` for your course\n+before you can complete these procedures.\n+\n+.. _Define the Manual Cohort Groups:\n+\n+==========================================\n+Define the Manual Cohort Groups\n+==========================================\n+\n+.. note:: Students can see the name of the cohort group they are assigned to. \n+ The message \"This post is visible only to Group *cohort name*\" appears with\n+ each post in discussion topics that support private, cohort-only\n+ participation.\n+\n+#. View the live version of your course. For example, in Studio click **View\n+   Live**.\n+\n+#. Click **Instructor**, then click **Membership**. \n+\n+#. Scroll to the **Cohort Management** section at the bottom.\n+\n+#. Click **Add Cohort Group**.\n+\n+#. Supply a name for the group, and then click **Save** below the **New Cohort\n+   Name** field.\n+\n+.. _Assign Students to Cohort Groups Manually:\n+\n+==========================================\n+Assign Students to Cohort Groups Manually\n+==========================================\n+\n+Manual assignments should be as complete as possible before your course starts.\n+If student enrollment continues after your course starts, you should continue\n+to assign new students to a cohort group. A student who is not assigned to a\n+manual cohort group by the time he visits a discussion topic will be\n+automatically assigned to an auto cohort group if you have configured one or to\n+the default cohort group if you have not.\n+\n+#. View the live version of your course. For example, in Studio click **View\n+   Live**.\n+\n+#. Click **Instructor**, then click **Membership**. \n+\n+#. Scroll to the **Cohort Management** section at the bottom.\n+\n+#. Select a cohort group from the drop down list.\n+\n+#. In the **Add students** field, enter the username or email address of a\n+   single student, or enter multiple names or addresses separated by commas or\n+   new lines. You can copy data from a CSV file of email addresses and paste it\n+   into this field.\n+\n+#. Click **Add Students**.\n+   \n+   The students are assigned to the selected manual cohort group. A message","path":"docs/en_us/course_authors/source/cohorts/cohort_config.rst","position":206,"original_position":206,"commit_id":"c3b489f4507fc6a1952e2335a19a3bf5421a5bd9","original_commit_id":"c3b489f4507fc6a1952e2335a19a3bf5421a5bd9","user":{"login":"cahrens","id":484484,"avatar_url":"https://avatars.githubusercontent.com/u/484484?v=2","gravatar_id":"","url":"https://api.github.com/users/cahrens","html_url":"https://github.com/cahrens","followers_url":"https://api.github.com/users/cahrens/followers","following_url":"https://api.github.com/users/cahrens/following{/other_user}","gists_url":"https://api.github.com/users/cahrens/gists{/gist_id}","starred_url":"https://api.github.com/users/cahrens/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cahrens/subscriptions","organizations_url":"https://api.github.com/users/cahrens/orgs","repos_url":"https://api.github.com/users/cahrens/repos","events_url":"https://api.github.com/users/cahrens/events{/privacy}","received_events_url":"https://api.github.com/users/cahrens/received_events","type":"User","site_admin":false},"body":"This paragraph is indented. Should it be?","created_at":"2014-10-02T16:15:46Z","updated_at":"2014-10-02T16:15:46Z","html_url":"https://github.com/edx/edx-platform/pull/5327#discussion_r18349300","pull_request_url":"https://api.github.com/repos/edx/edx-platform/pulls/5327","_links":{"self":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/comments/18349300"},"html":{"href":"https://github.com/edx/edx-platform/pull/5327#discussion_r18349300"},"pull_request":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/5327"}}},"pull_request":{"url":"https://api.github.com/repos/edx/edx-platform/pulls/5327","id":21611844,"html_url":"https://github.com/edx/edx-platform/pull/5327","diff_url":"https://github.com/edx/edx-platform/pull/5327.diff","patch_url":"https://github.com/edx/edx-platform/pull/5327.patch","issue_url":"https://api.github.com/repos/edx/edx-platform/issues/5327","number":5327,"state":"open","locked":false,"title":"Ahodges/doc/cohorts","user":{"login":"lamagnifica","id":6392274,"avatar_url":"https://avatars.githubusercontent.com/u/6392274?v=2","gravatar_id":"","url":"https://api.github.com/users/lamagnifica","html_url":"https://github.com/lamagnifica","followers_url":"https://api.github.com/users/lamagnifica/followers","following_url":"https://api.github.com/users/lamagnifica/following{/other_user}","gists_url":"https://api.github.com/users/lamagnifica/gists{/gist_id}","starred_url":"https://api.github.com/users/lamagnifica/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lamagnifica/subscriptions","organizations_url":"https://api.github.com/users/lamagnifica/orgs","repos_url":"https://api.github.com/users/lamagnifica/repos","events_url":"https://api.github.com/users/lamagnifica/events{/privacy}","received_events_url":"https://api.github.com/users/lamagnifica/received_events","type":"User","site_admin":false},"body":"@explorerleslie , @nasthagiri , @andy-armstrong , @gwprice , @jimabramson , @dan-f , @cahrens, @srpearce  , @WatsonEmily , @mhoeber \r\nThe cohorts/cohort_config and cohorts/cohorts_overview files and images are pretty solid. Questions occasionally in comments.\r\nI'll work on the section describing moderating discussions in a cohorted universe next.","created_at":"2014-09-22T21:50:26Z","updated_at":"2014-10-02T16:15:46Z","closed_at":null,"merged_at":null,"merge_commit_sha":"fb39f77468eaf59191561c0aa540edfad182d393","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/edx/edx-platform/pulls/5327/commits","review_comments_url":"https://api.github.com/repos/edx/edx-platform/pulls/5327/comments","review_comment_url":"https://api.github.com/repos/edx/edx-platform/pulls/comments/{number}","comments_url":"https://api.github.com/repos/edx/edx-platform/issues/5327/comments","statuses_url":"https://api.github.com/repos/edx/edx-platform/statuses/c3b489f4507fc6a1952e2335a19a3bf5421a5bd9","head":{"label":"edx:ahodges/doc/cohorts","ref":"ahodges/doc/cohorts","sha":"c3b489f4507fc6a1952e2335a19a3bf5421a5bd9","user":{"login":"edx","id":3179841,"avatar_url":"https://avatars.githubusercontent.com/u/3179841?v=2","gravatar_id":"","url":"https://api.github.com/users/edx","html_url":"https://github.com/edx","followers_url":"https://api.github.com/users/edx/followers","following_url":"https://api.github.com/users/edx/following{/other_user}","gists_url":"https://api.github.com/users/edx/gists{/gist_id}","starred_url":"https://api.github.com/users/edx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edx/subscriptions","organizations_url":"https://api.github.com/users/edx/orgs","repos_url":"https://api.github.com/users/edx/repos","events_url":"https://api.github.com/users/edx/events{/privacy}","received_events_url":"https://api.github.com/users/edx/received_events","type":"Organization","site_admin":false},"repo":{"id":10391073,"name":"edx-platform","full_name":"edx/edx-platform","owner":{"login":"edx","id":3179841,"avatar_url":"https://avatars.githubusercontent.com/u/3179841?v=2","gravatar_id":"","url":"https://api.github.com/users/edx","html_url":"https://github.com/edx","followers_url":"https://api.github.com/users/edx/followers","following_url":"https://api.github.com/users/edx/following{/other_user}","gists_url":"https://api.github.com/users/edx/gists{/gist_id}","starred_url":"https://api.github.com/users/edx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edx/subscriptions","organizations_url":"https://api.github.com/users/edx/orgs","repos_url":"https://api.github.com/users/edx/repos","events_url":"https://api.github.com/users/edx/events{/privacy}","received_events_url":"https://api.github.com/users/edx/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/edx/edx-platform","description":"Open edX, the edX platform that powers http://edx.org","fork":false,"url":"https://api.github.com/repos/edx/edx-platform","forks_url":"https://api.github.com/repos/edx/edx-platform/forks","keys_url":"https://api.github.com/repos/edx/edx-platform/keys{/key_id}","collaborators_url":"https://api.github.com/repos/edx/edx-platform/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/edx/edx-platform/teams","hooks_url":"https://api.github.com/repos/edx/edx-platform/hooks","issue_events_url":"https://api.github.com/repos/edx/edx-platform/issues/events{/number}","events_url":"https://api.github.com/repos/edx/edx-platform/events","assignees_url":"https://api.github.com/repos/edx/edx-platform/assignees{/user}","branches_url":"https://api.github.com/repos/edx/edx-platform/branches{/branch}","tags_url":"https://api.github.com/repos/edx/edx-platform/tags","blobs_url":"https://api.github.com/repos/edx/edx-platform/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/edx/edx-platform/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/edx/edx-platform/git/refs{/sha}","trees_url":"https://api.github.com/repos/edx/edx-platform/git/trees{/sha}","statuses_url":"https://api.github.com/repos/edx/edx-platform/statuses/{sha}","languages_url":"https://api.github.com/repos/edx/edx-platform/languages","stargazers_url":"https://api.github.com/repos/edx/edx-platform/stargazers","contributors_url":"https://api.github.com/repos/edx/edx-platform/contributors","subscribers_url":"https://api.github.com/repos/edx/edx-platform/subscribers","subscription_url":"https://api.github.com/repos/edx/edx-platform/subscription","commits_url":"https://api.github.com/repos/edx/edx-platform/commits{/sha}","git_commits_url":"https://api.github.com/repos/edx/edx-platform/git/commits{/sha}","comments_url":"https://api.github.com/repos/edx/edx-platform/comments{/number}","issue_comment_url":"https://api.github.com/repos/edx/edx-platform/issues/comments/{number}","contents_url":"https://api.github.com/repos/edx/edx-platform/contents/{+path}","compare_url":"https://api.github.com/repos/edx/edx-platform/compare/{base}...{head}","merges_url":"https://api.github.com/repos/edx/edx-platform/merges","archive_url":"https://api.github.com/repos/edx/edx-platform/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/edx/edx-platform/downloads","issues_url":"https://api.github.com/repos/edx/edx-platform/issues{/number}","pulls_url":"https://api.github.com/repos/edx/edx-platform/pulls{/number}","milestones_url":"https://api.github.com/repos/edx/edx-platform/milestones{/number}","notifications_url":"https://api.github.com/repos/edx/edx-platform/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/edx/edx-platform/labels{/name}","releases_url":"https://api.github.com/repos/edx/edx-platform/releases{/id}","created_at":"2013-05-30T20:20:38Z","updated_at":"2014-10-02T01:04:04Z","pushed_at":"2014-10-02T15:54:58Z","git_url":"git://github.com/edx/edx-platform.git","ssh_url":"git@github.com:edx/edx-platform.git","clone_url":"https://github.com/edx/edx-platform.git","svn_url":"https://github.com/edx/edx-platform","homepage":"http://openedx.org/","size":1638592,"stargazers_count":1444,"watchers_count":1444,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":827,"mirror_url":null,"open_issues_count":99,"forks":827,"open_issues":99,"watchers":1444,"default_branch":"master"}},"base":{"label":"edx:master","ref":"master","sha":"874c3381757ad2bc455200a43cca507e7a57dc3e","user":{"login":"edx","id":3179841,"avatar_url":"https://avatars.githubusercontent.com/u/3179841?v=2","gravatar_id":"","url":"https://api.github.com/users/edx","html_url":"https://github.com/edx","followers_url":"https://api.github.com/users/edx/followers","following_url":"https://api.github.com/users/edx/following{/other_user}","gists_url":"https://api.github.com/users/edx/gists{/gist_id}","starred_url":"https://api.github.com/users/edx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edx/subscriptions","organizations_url":"https://api.github.com/users/edx/orgs","repos_url":"https://api.github.com/users/edx/repos","events_url":"https://api.github.com/users/edx/events{/privacy}","received_events_url":"https://api.github.com/users/edx/received_events","type":"Organization","site_admin":false},"repo":{"id":10391073,"name":"edx-platform","full_name":"edx/edx-platform","owner":{"login":"edx","id":3179841,"avatar_url":"https://avatars.githubusercontent.com/u/3179841?v=2","gravatar_id":"","url":"https://api.github.com/users/edx","html_url":"https://github.com/edx","followers_url":"https://api.github.com/users/edx/followers","following_url":"https://api.github.com/users/edx/following{/other_user}","gists_url":"https://api.github.com/users/edx/gists{/gist_id}","starred_url":"https://api.github.com/users/edx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edx/subscriptions","organizations_url":"https://api.github.com/users/edx/orgs","repos_url":"https://api.github.com/users/edx/repos","events_url":"https://api.github.com/users/edx/events{/privacy}","received_events_url":"https://api.github.com/users/edx/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/edx/edx-platform","description":"Open edX, the edX platform that powers http://edx.org","fork":false,"url":"https://api.github.com/repos/edx/edx-platform","forks_url":"https://api.github.com/repos/edx/edx-platform/forks","keys_url":"https://api.github.com/repos/edx/edx-platform/keys{/key_id}","collaborators_url":"https://api.github.com/repos/edx/edx-platform/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/edx/edx-platform/teams","hooks_url":"https://api.github.com/repos/edx/edx-platform/hooks","issue_events_url":"https://api.github.com/repos/edx/edx-platform/issues/events{/number}","events_url":"https://api.github.com/repos/edx/edx-platform/events","assignees_url":"https://api.github.com/repos/edx/edx-platform/assignees{/user}","branches_url":"https://api.github.com/repos/edx/edx-platform/branches{/branch}","tags_url":"https://api.github.com/repos/edx/edx-platform/tags","blobs_url":"https://api.github.com/repos/edx/edx-platform/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/edx/edx-platform/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/edx/edx-platform/git/refs{/sha}","trees_url":"https://api.github.com/repos/edx/edx-platform/git/trees{/sha}","statuses_url":"https://api.github.com/repos/edx/edx-platform/statuses/{sha}","languages_url":"https://api.github.com/repos/edx/edx-platform/languages","stargazers_url":"https://api.github.com/repos/edx/edx-platform/stargazers","contributors_url":"https://api.github.com/repos/edx/edx-platform/contributors","subscribers_url":"https://api.github.com/repos/edx/edx-platform/subscribers","subscription_url":"https://api.github.com/repos/edx/edx-platform/subscription","commits_url":"https://api.github.com/repos/edx/edx-platform/commits{/sha}","git_commits_url":"https://api.github.com/repos/edx/edx-platform/git/commits{/sha}","comments_url":"https://api.github.com/repos/edx/edx-platform/comments{/number}","issue_comment_url":"https://api.github.com/repos/edx/edx-platform/issues/comments/{number}","contents_url":"https://api.github.com/repos/edx/edx-platform/contents/{+path}","compare_url":"https://api.github.com/repos/edx/edx-platform/compare/{base}...{head}","merges_url":"https://api.github.com/repos/edx/edx-platform/merges","archive_url":"https://api.github.com/repos/edx/edx-platform/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/edx/edx-platform/downloads","issues_url":"https://api.github.com/repos/edx/edx-platform/issues{/number}","pulls_url":"https://api.github.com/repos/edx/edx-platform/pulls{/number}","milestones_url":"https://api.github.com/repos/edx/edx-platform/milestones{/number}","notifications_url":"https://api.github.com/repos/edx/edx-platform/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/edx/edx-platform/labels{/name}","releases_url":"https://api.github.com/repos/edx/edx-platform/releases{/id}","created_at":"2013-05-30T20:20:38Z","updated_at":"2014-10-02T01:04:04Z","pushed_at":"2014-10-02T15:54:58Z","git_url":"git://github.com/edx/edx-platform.git","ssh_url":"git@github.com:edx/edx-platform.git","clone_url":"https://github.com/edx/edx-platform.git","svn_url":"https://github.com/edx/edx-platform","homepage":"http://openedx.org/","size":1638592,"stargazers_count":1444,"watchers_count":1444,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":827,"mirror_url":null,"open_issues_count":99,"forks":827,"open_issues":99,"watchers":1444,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/5327"},"html":{"href":"https://github.com/edx/edx-platform/pull/5327"},"issue":{"href":"https://api.github.com/repos/edx/edx-platform/issues/5327"},"comments":{"href":"https://api.github.com/repos/edx/edx-platform/issues/5327/comments"},"review_comments":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/5327/comments"},"review_comment":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/comments/{number}"},"commits":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/5327/commits"},"statuses":{"href":"https://api.github.com/repos/edx/edx-platform/statuses/c3b489f4507fc6a1952e2335a19a3bf5421a5bd9"}}}}