diff --git a/content/help/docs/share/about/contents.lr b/content/help/docs/share/about/contents.lr new file mode 100644 index 0000000..4f98f99 --- /dev/null +++ b/content/help/docs/share/about/contents.lr @@ -0,0 +1,51 @@ +_model: docspage +--- +title: About collaboration and sharing +--- +sort_key: 0 +--- +menu: /help/docs/share +--- +tocdesc: Overview of the collaborate and share features +--- +lead: Zenodo's collaboration and sharing features allow you to share individual records/drafts with other users and communities. +--- +body: + +From a high-level point of view Zenodo's features allow you to: + +- Share **individual records and drafts** with specific users, via links as well as allow guests/users to request access. +- Share **collection of records** via communities. + +### Individual records/drafts + +Individual records/drafts can be shared in different ways depending with who and how you want to share: + +- [User sharing](../user-sharing/) - enables you to share records/drafts with other Zenodo users. +- [Link sharing](../link-sharing/) - enables you to create a secret link which provides access to your record (e.g. with persons that do not have a Zenodo account). +- [Access requests](../access-requests) - allows guests/users to request access to a restricted/embargoed record. + +**Permissions** + +The table below provides an overview over which permissions can be granted for the different types of sharing: + +| | User sharing | Link sharing | Access requests | +| --- | --- | --- | -- | +| Can view
Grants access to view restricted/embargoed files of all current and future versions of a published record. | X | X | X | +| Can preview drafts
Grants access to view drafts (unpublished records) and restricted/embargoed files of all current and future versions of a record/draft. | X | X | - | +| Can edit
Grants access to edit drafts and view restricted/embargoed files of all current and future versions of a record. | X | X | - | +| Can manage
Grants access to manage access, edit drafts and view restricted/embargoed files of all current and future versions of a record. | X | - | - | + +### Collection of records + +The [communities](../../communities/) feature allow you to organise a **collection of records** and share the collection with **members** of the community who can be granted different roles as part of the community (see [about communities](../../communities/about-communities/)) + +This section focuses on how you submit drafts/records to a community and how you manage your submissions (independent of if you're a member or not): + +- [Submit for review](../submit-for-review/) - learn how to submit a draft (unpublished record) to a community. +- [Submit to community](../submit-to-community/) - learn how to submit an already published record to a community. +- [Managing submissions](../manage-submissions/) - learn how to manage your submissions. +- [Membership invitations](../membership-invitations/) - learn how to accept/decline membership invitations. + +--- +docs: diff --git a/content/help/docs/share/access-requests/contents.lr b/content/help/docs/share/access-requests/contents.lr index dae0d27..0743c2e 100644 --- a/content/help/docs/share/access-requests/contents.lr +++ b/content/help/docs/share/access-requests/contents.lr @@ -2,13 +2,15 @@ _model: docspage --- title: Access requests --- +tocdesc: Allows guests/users to request access to a restricted/embargoed record. +--- body: -Access requests enables other users and guests to request access to **restricted files** in your record (e.g. anonymised clinical trial data that can only be shared with medical professionals). +Access requests enables other users and guests to request access to view **restricted files** in your published record (e.g. anonymised clinical trial data that can only be shared with medical professionals). --- menu: /help/docs/share --- -sort_key: 2 +sort_key: 3 --- docs: diff --git a/content/help/docs/share/contents.lr b/content/help/docs/share/contents.lr index 5d1f3ea..2384fc5 100644 --- a/content/help/docs/share/contents.lr +++ b/content/help/docs/share/contents.lr @@ -9,8 +9,21 @@ sort_key: 3 menu: /help/docs/share --- body: + +!!! info + **Want to test Zenodo?** Use our sandbox environment on https://sandbox.zenodo.org to play. + +Zenodo's collaboration and sharing features allow you to share individual records/drafts with other users and communities. --- docs: +#### docsheader #### +text: Overview +---- +ref: overview +#### docstext #### + +text: +In this section, learn about the following topics: #### docstoc #### menu: /help/docs/share diff --git a/content/help/docs/share/link-sharing/contents.lr b/content/help/docs/share/link-sharing/contents.lr index de65704..2f8b9c8 100644 --- a/content/help/docs/share/link-sharing/contents.lr +++ b/content/help/docs/share/link-sharing/contents.lr @@ -2,24 +2,26 @@ _model: docspage --- title: Link sharing --- +tocdesc: Enables you to create a secret link which provides access to your record. +--- body: -Link sharing enables you to create a secret link which provides access to your record. The link can have an expiry date as well as +Link sharing enables you to create a secret link which provides access to your record. The link can also have an expiry date. If the person you want to share a record with already have a Zenodo account, you can also use [user sharing](../user-sharing/). ##### Permissions You can give the secret link one of the following three permissions: -- **Can view**: Link provide access to see restricted files in the record. -- **Can preview**: Link provide access to see a preview of a draft (unpublished record). -- **Can edit**: Link provide access to edit and create new versions of a record. +- **Can view**: Grants access to view restricted/embargoed files of all current and future versions of a published record. +- **Can preview draft**: Grants access to view drafts (unpublished records) and restricted/embargoed files of all current and future versions of a record/draft. +- **Can edit**: Grants access to edit drafts and view restricted/embargoed files of all current and future versions of a record. + +Note, the permissions apply to all current and future versions of a record/draft. --- menu: /help/docs/share --- -sort_key: 1 - - +sort_key: 2 --- docs: diff --git a/content/help/docs/share/manage-submissions/contents.lr b/content/help/docs/share/manage-submissions/contents.lr index bef4b9d..375823b 100644 --- a/content/help/docs/share/manage-submissions/contents.lr +++ b/content/help/docs/share/manage-submissions/contents.lr @@ -11,7 +11,7 @@ menu: /help/docs/share --- docs_show_toc: true --- -sort_key: 5 +sort_key: 6 --- docs: diff --git a/content/help/docs/share/membership-invitations/contents.lr b/content/help/docs/share/membership-invitations/contents.lr index a18ee07..1db5f2c 100644 --- a/content/help/docs/share/membership-invitations/contents.lr +++ b/content/help/docs/share/membership-invitations/contents.lr @@ -2,13 +2,15 @@ _model: docspage --- title: Membership invitations --- +tocdesc: Learn how to accept/decline membership invitations. +--- body: Community managers can invite you to join a community as a member. It is not yet possible for you to request to join a community. --- menu: /help/docs/share --- -sort_key: 6 +sort_key: 7 --- docs: diff --git a/content/help/docs/share/submit-for-review/contents.lr b/content/help/docs/share/submit-for-review/contents.lr index 0ed8945..fc12437 100644 --- a/content/help/docs/share/submit-for-review/contents.lr +++ b/content/help/docs/share/submit-for-review/contents.lr @@ -2,6 +2,8 @@ _model: docspage --- title: Submit for review --- +tocdesc: Learn how to submit a draft (unpublished record) to a community. +--- body: !!! info @@ -28,7 +30,7 @@ menu: /help/docs/share --- docs_show_toc: true --- -sort_key: 3 +sort_key: 4 --- docs: diff --git a/content/help/docs/share/submit-to-community/contents.lr b/content/help/docs/share/submit-to-community/contents.lr index e573ccb..fe70240 100644 --- a/content/help/docs/share/submit-to-community/contents.lr +++ b/content/help/docs/share/submit-to-community/contents.lr @@ -2,6 +2,8 @@ _model: docspage --- title: Submit to community --- +tocdesc: Learn how to submit an already published record to a community. +--- body: !!! info @@ -23,7 +25,7 @@ menu: /help/docs/share --- docs_show_toc: true --- -sort_key: 4 +sort_key: 5 --- docs: diff --git a/content/help/docs/share/user-sharing/add-people.png b/content/help/docs/share/user-sharing/add-people.png new file mode 100644 index 0000000..1f5fa63 Binary files /dev/null and b/content/help/docs/share/user-sharing/add-people.png differ diff --git a/content/help/docs/share/user-sharing/button-deposit.png b/content/help/docs/share/user-sharing/button-deposit.png new file mode 100644 index 0000000..8795be8 Binary files /dev/null and b/content/help/docs/share/user-sharing/button-deposit.png differ diff --git a/content/help/docs/share/user-sharing/button.png b/content/help/docs/share/user-sharing/button.png new file mode 100644 index 0000000..046d362 Binary files /dev/null and b/content/help/docs/share/user-sharing/button.png differ diff --git a/content/help/docs/share/user-sharing/change-saved.png b/content/help/docs/share/user-sharing/change-saved.png new file mode 100644 index 0000000..23f8a39 Binary files /dev/null and b/content/help/docs/share/user-sharing/change-saved.png differ diff --git a/content/help/docs/share/user-sharing/contents.lr b/content/help/docs/share/user-sharing/contents.lr new file mode 100644 index 0000000..4dff9e4 --- /dev/null +++ b/content/help/docs/share/user-sharing/contents.lr @@ -0,0 +1,117 @@ +_model: docspage +--- +title: User sharing +--- +tocdesc: Enables you to share records/drafts with other Zenodo users. +--- +body: + +Users sharing enables you to share a draft or record with another Zenodo user. If the person you want to share a record with does not have a Zenodo account, you can instead use [link sharing](../link-sharing/). + +##### Permissions + +You can grant one more users one of the following four permissions: + +- **Can view**: Grants access to view restricted/embargoed files of all current and future versions of a published record. +- **Can preview draft**: Grants access to view drafts (unpublished records) and restricted/embargoed files of all current and future versions of a record/draft. +- **Can edit**: Grants access to edit drafts and view restricted/embargoed files of all current and future versions of a record. +- **Can manage**: Grants access to manage access, edit drafts and view restricted/embargoed files of all current and future versions of a record. + +Note, the permissions apply to all current and future versions of a record. + +### Overview +--- +menu: /help/docs/share +--- +docs_show_toc: true +--- +sort_key: 1 +--- +docs: + +#### docsheader #### +text: Share a record +---- +ref: share-record +#### docsstep #### +step: 1 +---- +text: Go to the record you would like to share, and click the blue **Share** button. +---- +image: button.png +#### docsstep #### +step: 2 +---- +text: Click the green **Add people** button in the "Share access" dialog under the "People" tab. +---- +image: share-access.png +#### docsstep #### +step: 3 +---- +text: In the "Add people" dialog, use the **User** field to search for one or more users by name, username or email address. Note: only users who have [public profile visibility](../../profile/changing-profile-visibility/) can be found and added. +---- +image: add-people.png +#### docsstep #### +step: 4 +---- +text: Under **Access**, select the permission you would like to grant the selected users. +#### docsstep #### +step: 5 +---- +text: Choose if you want to **notify** the users and optionally write a message to the users. +#### docsstep #### +step: 6 +---- +text: Click the blue **Add** button to grant the users access. +#### docsheader #### +text: Share a draft +---- +ref: share-draft +#### docsstep #### +step: 1 +---- +text: From the [upload form](../../deposit/create-new-upload/#new-upload) click the blue **Share** button. Note, you must save and provide minimal metadata in order for the button to become enabled. +---- +image: button-deposit.png +#### docsstep #### +step: 2 +---- +text: Follow the [Share record](#share-record) instructions from step 2. +#### docsstep #### +step: 3 +---- +text: Note, to share a draft (unpublished record) you must grant one of following permissions: +- can preview drafts +- can edit +- can manage permissions. +#### docsheader #### +text: Change permission for a user +---- +ref: change +#### docsstep #### +step: 1 +---- +text: Open the "Share access" dialog (see [share record](#share-record) and [share draft](#share-draft)) +---- +image: share-access-change.png +#### docsstep #### +step: 2 +---- +text: Click the drop-down menu in the **Access** column and choose a new permission. Once the change has been saved, it will be confirmed with a small green tick mark. +---- +image: change-saved.png + +#### docsheader #### +text: Remove a user +---- +ref: remove +#### docsstep #### +step: 1 +---- +text: Open the "Share access" dialog (see [share record](#share-record) and [share draft](#share-draft)) +---- +image: share-access-after.png +#### docsstep #### +step: 2 +---- +text: Click the red **Delete** button next to the user you want to remove access from. diff --git a/content/help/docs/share/user-sharing/links.png b/content/help/docs/share/user-sharing/links.png new file mode 100644 index 0000000..c9e0472 Binary files /dev/null and b/content/help/docs/share/user-sharing/links.png differ diff --git a/content/help/docs/share/user-sharing/secret.png b/content/help/docs/share/user-sharing/secret.png new file mode 100644 index 0000000..8df58de Binary files /dev/null and b/content/help/docs/share/user-sharing/secret.png differ diff --git a/content/help/docs/share/user-sharing/share-access-after.png b/content/help/docs/share/user-sharing/share-access-after.png new file mode 100644 index 0000000..35ed7e6 Binary files /dev/null and b/content/help/docs/share/user-sharing/share-access-after.png differ diff --git a/content/help/docs/share/user-sharing/share-access-change.png b/content/help/docs/share/user-sharing/share-access-change.png new file mode 100644 index 0000000..9f5e06a Binary files /dev/null and b/content/help/docs/share/user-sharing/share-access-change.png differ diff --git a/content/help/docs/share/user-sharing/share-access.png b/content/help/docs/share/user-sharing/share-access.png new file mode 100644 index 0000000..2103a3e Binary files /dev/null and b/content/help/docs/share/user-sharing/share-access.png differ