Skip to content

Commit

Permalink
readme: remove mention of the service result resolver
Browse files Browse the repository at this point in the history
* because that's been added to invenio-app-rdm v12.0.7
  • Loading branch information
max-moser committed Sep 18, 2024
1 parent 2955d60 commit 400d45a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 12 deletions.
14 changes: 3 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ In contrast, `Invenio-Curations` defines a fixed group of users to act as review
Requirements
************

Requires InvenioRDM v12 or higher (``invenio-app-rdm >= 12.0.5``).
Requires InvenioRDM v12 or higher (``invenio-app-rdm >= 12.0.7``).


How to set up
Expand All @@ -60,22 +60,19 @@ The following sections should guide you through the required adaptations.
Update ``invenio.cfg``
----------------------

Add `notification builders` and `entity resolver` for `groups`
Add `notification builders` for `groups`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Currently, requests can only be sent to a single `receiver`.
However, curation reviews are typically performed by a `group` of people rather than one single fixed `user`.
Thus, the curation requests are sent to a `group` rather than a single `user` in the system so that all users with a certain `role` can receive and act on curation requests.

To enable resolution of user groups, an `entity resolver` has to be added to the configuration.

Additionally, notification builders have to be configured so that notifications are sent out to the involved users whenever something's happening in the curation review.

.. code-block:: python
from invenio_app_rdm.config import NOTIFICATIONS_BUILDERS, NOTIFICATIONS_ENTITY_RESOLVERS
from invenio_app_rdm.config import NOTIFICATIONS_BUILDERS
from invenio_curations.config import CURATIONS_NOTIFICATIONS_BUILDERS
from invenio_records_resources.references.entity_resolvers import ServiceResultResolver
# enable sending of notifications when something's happening in the review
NOTIFICATIONS_BUILDERS = {
Expand All @@ -84,11 +81,6 @@ Additionally, notification builders have to be configured so that notifications
**CURATIONS_NOTIFICATIONS_BUILDERS
}
# enable requests to target groups of users (i.e. `roles`)
NOTIFICATIONS_ENTITY_RESOLVERS = NOTIFICATIONS_ENTITY_RESOLVERS + [
ServiceResultResolver(service_id="groups", type_key="group")
]
Add service component
^^^^^^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ tests =
invenio-search[opensearch2]>=2.0.0
pytest-invenio>=2.1.0,<3.0.0
sphinx>=4.5.0
invenio-app-rdm>=12.0.0,<14.0.0
invenio-app-rdm>=12.0.7,<14.0.0
opensearch1 =
invenio-search[opensearch1]>=2.1.0,<3.0.0
opensearch2 =
Expand Down

0 comments on commit 400d45a

Please sign in to comment.