Skip to content

Conversation

zzacharo
Copy link
Member

@zzacharo zzacharo commented Aug 1, 2025

closes #847

@zzacharo zzacharo force-pushed the document-request-reviewers branch 2 times, most recently from 4b0c76d to c7df75b Compare August 25, 2025 12:54
@zzacharo zzacharo marked this pull request as ready for review August 25, 2025 12:58
@zzacharo zzacharo changed the title wip: document request reviewers document request reviewers Aug 25, 2025
@zzacharo zzacharo force-pushed the document-request-reviewers branch from c7df75b to bdd624a Compare August 25, 2025 13:04
Copy link
Contributor

@ntarocco ntarocco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot! Added a few comments to improve clarity

- may require clarifications (i.e. a conversation) between the creator of the request and the recipient(s)
- may expire after a certain amount of time

### Reviewers in Requests

Reviewers are optional participants in the request process who can be assigned to provide expert opinion, feedback, or recommendations. Unlike the receiver who makes the final decision to accept or decline the request, reviewers serve as consultants or advisors.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would use the terms consultant or advisor:

Suggested change
Reviewers are optional participants in the request process who can be assigned to provide expert opinion, feedback, or recommendations. Unlike the receiver who makes the final decision to accept or decline the request, reviewers serve as consultants or advisors.
Reviewers are optional participants in a request process. They provide expert opinions, feedback, or recommendations but cannot make the final decision to accept or decline the request. That responsibility lies solely with the receiver.

@@ -0,0 +1,72 @@
# Requests

_Introduced in InvenioRDM v14_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
_Introduced in InvenioRDM v14_
_Introduced in v14_


Configure the requests system in InvenioRDM, including the reviewers feature for enhanced review workflows.

## Reviewers Configuration
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should use CamelCase for titles (as always suggested by LLMs). Applicable to all new titles.

Suggested change
## Reviewers Configuration
## Reviewers configuration


## Reviewers Configuration

The reviewers feature enables assignment of external experts, collaborators, or community members to provide feedback on requests without granting them decision-making authority.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The reviewers feature enables assignment of external experts, collaborators, or community members to provide feedback on requests without granting them decision-making authority.
The reviewers feature enables assignment of external experts, collaborators, or community members to provide feedback on requests without granting them the possibility of accepting or declining a request.


```python
# Enable assignment of groups as reviewers (requires invenio-users-resources)
USERS_RESOURCES_GROUPS_ENABLED = True
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove this flag (from the code): if groups is enabled, why having this extra flag? Any benefit?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the flag that enable groups in the system, it was not newly added.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah right, then in the doc it is not super clear, in particular the comment

USERS_RESOURCES_GROUPS_ENABLED = True
```

- **Requirements**: Requires the `invenio-users-resources` module to be installed and configured
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's always the case in InvenioRDM

Suggested change
- **Requirements**: Requires the `invenio-users-resources` module to be installed and configured


## Permissions

Reviewer assignment requires appropriate community permissions:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Reviewer assignment requires appropriate community permissions:
By default, reviewer can be added or removed by community members with roles:

Can the submitter assign reviewers?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We decided not to allow them in the first implementation.


Reviewer assignment requires appropriate community permissions:
- **Owners** and **managers** can assign/remove reviewers
- **Curators** can assign/remove reviewers (if configured)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how do I configure it?

@@ -126,4 +126,6 @@ In the **Requests** tab, you can view all requests for your community. It allows

The request page provides a dedicated space for communication. You can **have a conversation with the submitter** directly within the request, and you can **accept or decline the inclusion request** based on your community's curation policies.

You can find the high-level architecture documentation for communities [here](../maintenance/architecture/communities.md).
When a submission requires expert input or peer review, you can **assign reviewers** to give specific users or groups access to evaluate the request. This allows you to share the request with external experts, collaborators outside your community, or community members who normally wouldn't have access (such as readers). Reviewers can provide feedback on the research publication draft or assess whether a record meets your community's inclusion criteria. They participate in the request conversation and share their expertise to help you make an informed curation decision, while you retain the final authority to accept or decline the request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When a submission requires expert input or peer review, you can **assign reviewers** to give specific users or groups access to evaluate the request. This allows you to share the request with external experts, collaborators outside your community, or community members who normally wouldn't have access (such as readers). Reviewers can provide feedback on the research publication draft or assess whether a record meets your community's inclusion criteria. They participate in the request conversation and share their expertise to help you make an informed curation decision, while you retain the final authority to accept or decline the request.
When a submission requires expert input or peer review, you can **assign reviewers** to give specific users or groups access to review the inclusion request. This allows you to share the request with external experts, collaborators outside your community, or community members who normally wouldn't have access (such as readers). Reviewers can provide feedback on the research publication draft or assess whether a record meets your community's inclusion criteria. They participate in the request conversation and share their expertise to help you make an informed curation decision, while you retain the final authority to accept or decline the request.

while you retain the final authority to accept or decline the request.

Unclear, who is you?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants