diff --git a/src/docs/source/docs/groups.md b/src/docs/source/docs/groups.md index 61115ca57..6a5e490f2 100644 --- a/src/docs/source/docs/groups.md +++ b/src/docs/source/docs/groups.md @@ -3,24 +3,46 @@ Groups ### Overview -For an overview of how to add and manage groups on PECE, please see the -following YouTube video. - - - Steps to Create Group -------------------------- -1. Navigate to ‘Dashboard’. This link is listed in the main menu. +1. Navigate to ‘Create Group’. This link is listed in the main menu. + + ![](media/group-1.png) 2. Select to add a group. You will be directed to a web form to create your group. -3. Enter the relevant fields (see Field glossary for explanation). +3. Enter a title in the "Name" textbox for your new group. + +4. In the "Image" field, you can upload an image related to your group by first removing the placeholder image and clicking "Add media". + + ![](media/group-2.png) + + ![](media/group-3.png) + +5. Add a description related to your group, in the "Description" textbox. + +6. The "Group visibility" field, determines whether the group can be viewed by all site visitors or only by its own members. +It does not determine the visibility of group content. Select whether you would like your group to be publicly or privately visible. + + ![](media/group-4.png) + +7. The "Substantive logic" provides the opportunity to describe the rational behind the creation of the group. +You may select a substantive logic by typing in the first few letters and making a selection from the drop-down menu. + +8. If there are any other group members or managers, add them by typing the first few letters of their name into the field. +Their screen name should pop up. Select their name. To add more than one contributor, click the "Add another item" button and repeat the same process. -4. Note that in order to create a group as a child of another group, you should -select the Parent Group in the Group Audience field. +9. Next, add optional keyword tags to your timeline essay. Tag the content. As you type, suggested tags will be automatically generated if they exist already in the system. +We recommend following these suggestions and using existing tags if they are not too different from what you intended, but feel free to make up new tags! -5. Save the group. You are now the group administrator. +10. The "Relations" field allows you to select group(s) that are related to the current sub-group being made. +Type in the first few letters and a drop-down menu of groups to choose from will appear. + + ![](media/group-5.png) + +11. Finally, click “Save” at the top of the page to save your work. +And remember: all of these settings can be revised at any time. You are now the group administrator. Steps to Join a Group @@ -29,27 +51,41 @@ Steps to Join a Group 1. Navigate to ‘Collaborate’. This tab is listed on the main menu bar. Here, you will find all of the open groups. + ![](media/group-6) + 2. Navigate by clicking through the arrows on the bottom of the pages, or by searching if you know the name of the group. + ![](media/group-7) + 3. Once you locate the group, click on the link to navigate to the group page. -4. Click ‘Subscribe to group’ on the right hand of the screen. The group administrator will +4. [To be revised, no current way to join a group] Click ‘Subscribe to group’ on the right hand of the screen. The group administrator will have to approve your request before you are considered a member of a group, and this may take some time. Once you are listed as a member, you should be able to begin associating content with a group. -Steps to Manage Group Memberships +Steps to Manage Group Memberships -------------------------- 1. If you created a group or have been appointed as an administrator of a group, navigate to the group’s page from your dashboard or from the “Collaborate” link. -2. Click on the Group tab in the edit menu. (You will not see this tab if you are not a group owner.) + To do this from your dashboard, click the edit button next to your group's name or + click "See and sort all my managed groups". + + ![](media/group-8) -3. Select the link ‘People.’ Here you can see a list of site users that have requested to join the group or that have already been approved. If a user has been approved, their State will be listed as "Active"; otherwise, their State will be listed as "Pending". + To do this from the "Collaborate" link, select your group to navigate to the group page. Click the "Edit" link where you can manage group memberships. Save your changes. -### Approving a Group Member + ![](media/group-9) + +2. [To be revised] Click on the Group tab in the edit menu. (You will not see this tab if you are not a group owner.) + +3. [To be revised] Select the link ‘People.’ Here you can see a list of site users that have requested to join the group or that have already been approved. If a user has been approved, their State will be listed as "Active"; otherwise, their State will be listed as "Pending". + + +### Approving a Group Member [The below is to be revised, no current way to approve] 1. To approve a group membership for a Pending user, click edit at the end of the row with their username. @@ -59,22 +95,22 @@ group, navigate to the group’s page from your dashboard or from the “Collabo 4. Click "Update Membership". -### Changing a Group Member's roles +### Changing a Group Member's roles -1. To change a group member's role, click edit at the end of the row with their username. +1. To change a group member's role, navigate to the group's page and select "Edit". -2. Select a new group user role for the user. +2. Select "Remove" next to the group member's username under the category of their current role. -3. Click "Update Membership". +3. Add the group member by their username under the category of the new role. ### Deleting a Group Member -1. To delete a group member, click remove at the end of the row with the user's username. +1. To delete a group member, navigate to the group's page and select "Edit". -2. Click "Remove". +2. Scroll down to "Group members" and click "Remove" next to their name. -Adding Artifacts to Groups +Adding Artifacts to Groups [To be edited] ----- 1. Follow instructions to [add an artifact](../artifacts), and designate the Group Audience to which you would like the group added. @@ -106,9 +142,12 @@ which will soon be listed on the group page. ### What do the different group membership roles mean? +A group manager is the person responsible for stewarding the group on PECE. The manager has the ability to make edits to the group itself and to add or remove members. +Group members have access to view artifacts, essays, etc when the view permissions for that content have been restricted to the group. Administrators can manage groups as described above. **There is no difference between a researcher and a contributor in a group.** + ### I’m trying to approve a user’s request to join a group, and I keep getting an error. What’s going on? This is a bug that has happened to a few group managers over the past diff --git a/src/docs/source/docs/media/group-1.png b/src/docs/source/docs/media/group-1.png new file mode 100644 index 000000000..1807b80f4 Binary files /dev/null and b/src/docs/source/docs/media/group-1.png differ diff --git a/src/docs/source/docs/media/group-2.png b/src/docs/source/docs/media/group-2.png new file mode 100644 index 000000000..3f6dd7f60 Binary files /dev/null and b/src/docs/source/docs/media/group-2.png differ diff --git a/src/docs/source/docs/media/group-3.png b/src/docs/source/docs/media/group-3.png new file mode 100644 index 000000000..5fb966807 Binary files /dev/null and b/src/docs/source/docs/media/group-3.png differ diff --git a/src/docs/source/docs/media/group-4.png b/src/docs/source/docs/media/group-4.png new file mode 100644 index 000000000..29ec99401 Binary files /dev/null and b/src/docs/source/docs/media/group-4.png differ diff --git a/src/docs/source/docs/media/group-5.png b/src/docs/source/docs/media/group-5.png new file mode 100644 index 000000000..e4ebe8fcc Binary files /dev/null and b/src/docs/source/docs/media/group-5.png differ diff --git a/src/docs/source/docs/media/group-6.png b/src/docs/source/docs/media/group-6.png new file mode 100644 index 000000000..ad4f7a804 Binary files /dev/null and b/src/docs/source/docs/media/group-6.png differ diff --git a/src/docs/source/docs/media/group-7.png b/src/docs/source/docs/media/group-7.png new file mode 100644 index 000000000..b92bc3899 Binary files /dev/null and b/src/docs/source/docs/media/group-7.png differ diff --git a/src/docs/source/docs/media/group-8.png b/src/docs/source/docs/media/group-8.png new file mode 100644 index 000000000..16cb01e51 Binary files /dev/null and b/src/docs/source/docs/media/group-8.png differ diff --git a/src/docs/source/docs/media/group-9.png b/src/docs/source/docs/media/group-9.png new file mode 100644 index 000000000..80adaa853 Binary files /dev/null and b/src/docs/source/docs/media/group-9.png differ