diff --git a/docs/communities/communities.md b/docs/communities/communities.md index 5f5da14..73d1ee3 100644 --- a/docs/communities/communities.md +++ b/docs/communities/communities.md @@ -1,5 +1,56 @@ # Communities -## New community +On CDS, communities are spaces in which records are curated by specific groups of people, depending on the community's scope. +Communities can allow: -## Your communities +- **Curating** records; specific community members can review submitted records before publication. +- **Managing permissions** by specifying which users or CERN Groups can submit new records. +- **Creating custom pages** such as an About page or a Curation Policy + +All records on CDS belong to at least one community. +When a record is created, it must be submitted to a community, but after publication it can also be submitted +to additional ones. + +## Create a community + +In order to ensure communities have a coordinated, user-friendly structure, the CDS team creates communities on request, following careful evaluation. +Please [contact the CDS team via ServiceNow](https://cern.service-now.com/service-portal?id=sc_cat_item&name=request&se=CDS-Service), specifying the following details: + +- The intended name +- A square logo (maximum 1MB) +- A short description of what the community will be used for +- The type of records that will be published in the community (please send links to examples if possible) +- Whether reviews should be mandatory for newly submitted records (see [Submission policy](./manage.md#submission-policy)) +- Whether the community's contents should be publicly visible +- The name of a dedicated [GMS group](https://auth.docs.cern.ch/groups/overview/) to set as the initial member of the community + +## Members and roles + +Communities have members, each with a role which describes their level of access. +A member can be a CERN user or a group. +Community owners can specify the initial members, which can then later be edited. + +Each member can have one of the following roles: + +- **Reader**: Can view all records inside the community, including restricted ones. +- **Curator**: Can curate/review records submitted to the community and can view all records. +- **Manager**: Can manage members and roles, can curate records, and can view all records. +- **Owner**: Full administrative control over all aspects of the community. + +!!! info "Access for non-members of the community" + + CDS users who are not members of a community can still view its public records and its details. + This can be changed in the community's settings. + + Non-members cannot view the community's restricted records, unless they have been granted [explicit permission](../deposit/access-share.md) on a per-record basis. + +[Find out more](./manage.md#members) about managing community members. + +## View your communities + +To view the communities you are a member of, or to see a full list of communities on CDS, click on the "Communities" tab at the top of the page. + +![Communities tab on the CDS website](./images/communities_tab.png) + +The communities you are a member of are listed under "My communities", while the latest communities created on CDS are under "New communities". +To show more results in either section and to search for communities, click "See all". diff --git a/docs/communities/images/communities_tab.png b/docs/communities/images/communities_tab.png new file mode 100644 index 0000000..452f71a Binary files /dev/null and b/docs/communities/images/communities_tab.png differ diff --git a/docs/communities/images/community_invitation.png b/docs/communities/images/community_invitation.png new file mode 100644 index 0000000..5b151b2 Binary files /dev/null and b/docs/communities/images/community_invitation.png differ diff --git a/docs/communities/images/community_members.png b/docs/communities/images/community_members.png new file mode 100644 index 0000000..3cbdbe7 Binary files /dev/null and b/docs/communities/images/community_members.png differ diff --git a/docs/communities/images/community_pages.png b/docs/communities/images/community_pages.png new file mode 100644 index 0000000..c23a6ce Binary files /dev/null and b/docs/communities/images/community_pages.png differ diff --git a/docs/communities/images/community_profile.png b/docs/communities/images/community_profile.png new file mode 100644 index 0000000..424a910 Binary files /dev/null and b/docs/communities/images/community_profile.png differ diff --git a/docs/communities/images/community_submission_policy.png b/docs/communities/images/community_submission_policy.png new file mode 100644 index 0000000..7bbf4da Binary files /dev/null and b/docs/communities/images/community_submission_policy.png differ diff --git a/docs/communities/images/community_visibility.png b/docs/communities/images/community_visibility.png new file mode 100644 index 0000000..a42cc7e Binary files /dev/null and b/docs/communities/images/community_visibility.png differ diff --git a/docs/communities/images/request_list.png b/docs/communities/images/request_list.png new file mode 100644 index 0000000..93d1533 Binary files /dev/null and b/docs/communities/images/request_list.png differ diff --git a/docs/communities/images/role_dropdown.png b/docs/communities/images/role_dropdown.png new file mode 100644 index 0000000..cbe46c3 Binary files /dev/null and b/docs/communities/images/role_dropdown.png differ diff --git a/docs/communities/manage.md b/docs/communities/manage.md index 88d53da..e053738 100644 --- a/docs/communities/manage.md +++ b/docs/communities/manage.md @@ -1,11 +1,117 @@ # Manage a community +Communities can be managed by their members. What each member can do depends on their role. +See [About communities](./communities.md#members-and-roles) for the list of roles and what they mean. + ## Settings +Properties of a community can be changed by members who have the **Manager** or **Owner** role. Open the community and use the **Settings** tab. + +### Profile + +On the "Settings" tab you can change public-facing information about the community. +We recommend filling in as much of this as possible so visitors understand the purpose and background of the community. + +![The community profile page](./images/community_profile.png) + +The profile picture acts as a logo, shown across CDS wherever the community is referenced. + +Please ensure the picture meets the following criteria: + +- Stays clear even when very small +- Square shaped +- Maximum 1MB + +### Visibility + +![The visibility settings within the community settings tab](./images/community_visibility.png) + +On the "Privileges" section of the "Settings" tab, you can control whether the community itself is public or restricted. + +- **Public** communities are visible to everyone and show up in the list of communities on the CDS website. All parts of the community's profile can be seen by everyone, as well as the public records that belong to it. Restricted records can be seen by the members of the community or users with explicit access. + +- **Restricted** communities are only accessible by members. The community does not show up search results and its profile cannot be viewed by non-members. All records of the community must be restricted too. + +You can also configure whether the list of members is visible to everyone or only to members. + +### Submission policy + +![The submission policy settings within the community settings tab](./images/community_submission_policy.png) + +The submission policy defines who is allowed to submit records to the community and whether they will need to undergo a review before publication. + +The review policy sets which submissions require a review. +By default, all submissions require a review. +You can change this so that members with certain roles (as shown) can submit directly without a review. +When these users submit a record, the record will get associated with the community instantly. + +You can also disable reviews entirely by selecting "Allow all members to publish without review". +Records submitted by non-members of the community (if allowed) still require a review. + +By default, any CDS user can submit records to a public community. +You can change the records submission policy to "Closed" so that only members can submit records. + +### Pages + +![The page settings within the community settings tab](./images/community_pages.png) + +On the "Pages" section of the "Settings" tab, you can customise the "Curation policy" and "About" pages, which are shown to all users viewing the community. + +- The **Curation policy** can be used to specify criteria and guidelines for records submitted to the community. Specify as much detail as possible to make reviewing submissions easier. +- The **About** page can be used to provide more information about the community and its purpose. + ## Members -## Browse & collections +You can view a list of the community's members and their roles in the "Members" tab. + +![The list of members and their roles on the community page](./images/community_members.png) + +Members can be either **people** (referring to CERN users) or **groups** (referring to [GMS groups](https://auth.docs.cern.ch/groups/overview/), formerly known as e-groups). +If a role is applied to a group, it will be applied to all members of the group. + +!!! info "Permissions for managing members" + + Only members with the **Owner** and **Manager** roles can manage members. See more details about roles in [About communities](./communities.md#members-and-roles). + +To **add a new member**: + +1. Click on "Invite". +2. Select either the "People" or "Groups" tab +3. Search for the user or group you want to add. +4. Select the role to assign to the member +5. Click on "Invite". + +Users will receive an email invitation to join the community; their membership will only be confirmed once they have accepted the invitation. +Groups will be added immediately. + +You can view pending invitations in the "Invitations" tab. +Invitations that have not yet been accepted or rejected will be shown in the "Open" tab. +You can change the member's role before they accept the invitation. + +![The invitations tab](./images/community_invitation.png) + +- To **cancel an invitation**, click on the invited member's name, and click on the "Cancel" button. + +- To **remove a member**, click the "Remove" button next to their name. + +- To **change a member's role**, select a new role from the dropdown menu. + + ![Role dropdown menu](./images/role_dropdown.png) + +!!! info "Membership visibility" + + You can change whether others can see your membership by selecting an option from the dropdown menu next to your name. + +## Managing submission requests + +When someone submits a new record to your community, it may appear as a **submission request** for your community to review, depending on the community's [review policy](#submission-policy). +These requests are shown in the community's "Requests" tab. + +Curators review submitted records and suggest changes to ensure their content and metadata meet the community's requirements. + +![The requests tab](./images/request_list.png) -## Submissions: requests & reviews +Community members with a role of **Curator** or above (see [more details about member roles](./communities.md#members-and-roles)) can view these requests from the community interface, **review** the submitted record, leave **comments**, and **accept** or **decline** it. Until a request is accepted, the record is in the "In review" stage and is not publicly visible as part of the community. +The record may still be accessible if it has already been published to another community. -## Curation +See [About reviews](../review/review.md) for more details. diff --git a/docs/review/comments.md b/docs/review/comments.md index 7fe4a3b..ecae6cb 100644 --- a/docs/review/comments.md +++ b/docs/review/comments.md @@ -115,8 +115,8 @@ When a conversation is locked or unlocked, an event appears in the conversation - Replying to existing comments is still allowed (replies can be created and deleted but not edited) - -Community curators (and above) can unlock the conversation at any time. +Members of the community to which the record is submitted (with the **Curator** role or above) can lock and unlock the conversation. +See more information about roles in [About communities](../communities/communities.md#members-and-roles). To lock a conversation, click the "Lock conversation" button in the right-hand sidebar: diff --git a/mkdocs.yml b/mkdocs.yml index 3a59dbc..c883897 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -114,7 +114,7 @@ nav: - How to search: search/search.md - Communities: - About communities: communities/communities.md - - Manage: communities/manage.md + - Manage communities: communities/manage.md - Submit: communities/submit.md - Reviews: - About reviews: review/review.md