Skip to content

Commit 198c52a

Browse files
committed
review: Add review workflow docs
1 parent 23d3cda commit 198c52a

4 files changed

Lines changed: 64 additions & 0 deletions

File tree

38.1 KB
Loading
130 KB
Loading
17.3 KB
Loading

docs/review/review.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,65 @@
11
# Review process
2+
3+
A review is the process by which a community evaluates a record before accepting it. When you submit a record to a community, a **submission request** is created. This request acts as a shared workspace between you and the community curators: both sides can exchange comments, request changes, and track the outcome — all without leaving CDS.
4+
5+
![Request Page](./images/request_page.png)
6+
7+
## Who takes part
8+
9+
| Role | Who | What they can do |
10+
|---|---|---|
11+
| **Submitter** | The person who uploaded the record and submitted it to the community | Submit, edit the record during review, cancel the request, comment |
12+
| **Curator** | A community member with the Curator role or above | Accept or decline the request, comment, invite reviewers |
13+
| **Reviewer** | Any CDS user explicitly invited to the request by a curator | View the request and comment; cannot accept or decline |
14+
15+
Curators can invite any CDS user as a reviewer on a specific submission, even if that person is not a community member. This is useful when specialist input is needed before a decision is made. See [Commenting](comments.md) for details on how to use the conversation features during a review.
16+
17+
## Typical workflow
18+
19+
### 1. Submission
20+
21+
You can submit a record to a community in two ways:
22+
23+
- **During upload**: Before publishing, select the community in the deposit form. The record will not be published until a curator accepts the submission.
24+
- **After publishing**: See [Submit to a community](../communities/submit.md#multiple-communities) for details.
25+
26+
![Select Community](./images/select_community.png)
27+
![Change Community](./images/change_community.png)
28+
29+
### 2. Review
30+
31+
Once submitted, the request appears in the community's **Requests** tab, visible to all curators. The curators can:
32+
33+
- Read the record and its metadata.
34+
- Leave comments or ask for changes (see [Commenting](comments.md)).
35+
- Invite additional reviewers.
36+
37+
You will receive a notification if a curator leaves a comment. You can update the record's metadata and ask for a re-review by dropping a comment.
38+
39+
!!! note
40+
41+
Both you and the curators can edit the record's metadata while it is under review. Files can still be updated before acceptance.
42+
43+
### 3. Decision
44+
45+
The curator will make one of two decisions:
46+
47+
**Accepted**
48+
49+
- If the record was not yet published, it is **published automatically** and added to the community.
50+
- If the record was already published, it is **added to the community** without any further action needed from you.
51+
52+
**Declined**
53+
54+
- The record is not added to the community. If it was not yet published, it remains as a draft and you can continue editing or publish it independently.
55+
- You cannot resubmit the same record to the same community after a decline. If you believe the decision was made in error, contact the community curators directly.
56+
57+
### 4. After the review
58+
59+
Once a request is closed (accepted or declined), the conversation is preserved and remains readable. If the conversation is locked, no further comments can be added. See [Locking the conversation](comments.md#locking-the-conversation) for details.
60+
61+
If you want to remove an accepted record from a community at a later point, see [Removing from a community](../communities/submit.md#removing-from-a-community).
62+
63+
## Cancelling a pending submission
64+
65+
If you change your mind before a curator has made a decision, you can cancel the submission request. Open the request from the record's page and click **Cancel request**. The record is not affected; if it was not yet published, it remains as a draft.

0 commit comments

Comments
 (0)