Skip to content

Commit 148fa39

Browse files
committed
v12/v13: better doc for new config vars
1 parent 73aca89 commit 148fa39

File tree

4 files changed

+52
-12
lines changed

4 files changed

+52
-12
lines changed

docs/operate/customize/dois.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ DATACITE_FORMAT = "{prefix}/inveniordm.{id}"
7777
#### OAI-PMH
7878

7979
The OAI-PMH server's metadata format ``oai_datacite`` that allows your records
80-
to be harvested in DataCite XML needs to be configured with your DataCite data
80+
to be harvested in DataCite XML needs to be configured with your DataCite data
8181
center symbol. This is only required if you want your records to be harvestable in DataCite XML format.
8282

8383
```python
@@ -86,10 +86,10 @@ DATACITE_DATACENTER_SYMBOL = "CERN.INVENIORDM"
8686

8787
### Versioning and externally managed DOI
8888

89-
By default, InvenioRDM allows versioning for any DOI type - internally or externally managed.
90-
Internally managed DOIs are DOIs registered by your instance and minted on Datacite.
91-
External DOIs are DOIs already minted and simply passed to your instance.
92-
As such, having an internally managed DOI for the next version of a record with an external DOI may not be desired.
89+
By default, InvenioRDM allows versioning for any DOI type - internally or externally managed.
90+
Internally managed DOIs are DOIs registered by your instance and minted on Datacite.
91+
External DOIs are DOIs already minted and simply passed to your instance.
92+
As such, having an internally managed DOI for the next version of a record with an external DOI may not be desired.
9393
To disable versioning for external DOIs you need to set
9494

9595
```python
@@ -147,7 +147,7 @@ RDM_PERSISTENT_IDENTIFIERS = {
147147
},
148148
}
149149
```
150-
You [can view the default configuration for `RDM_PERSISTENT_IDENTIFIERS` in invenio-rdm-records](https://github.com/inveniosoftware/invenio-rdm-records/blob/master/invenio_rdm_records/config.py)
150+
You [can inspect here](https://github.com/inveniosoftware/invenio-rdm-records/blob/master/invenio_rdm_records/config.py#L393) the default configuration for `RDM_PERSISTENT_IDENTIFIERS`.
151151

152152
### Optional DOI User Interface and Advanced Configuration
153153

@@ -159,7 +159,31 @@ InvenioRDM now includes a user interface to allow users to choose whether or not
159159

160160
This will display when both main and parent DOIs are configured as
161161
optional. You can also set the default button selection with the
162-
"doi" "ui" "default_selected" option, which can be "yes", "no" or "not_needed"
162+
"doi" "ui" "default_selected" option, which can be "yes", "no" or "not_needed". In your `invenio.cfg`, change:
163+
164+
```diff
165+
RDM_PARENT_PERSISTENT_IDENTIFIERS = {
166+
...
167+
"doi": {
168+
...
169+
- "required": True,
170+
+ "required": False,
171+
...
172+
},
173+
...
174+
}
175+
RDM_PERSISTENT_IDENTIFIERS = {
176+
...
177+
"doi": {
178+
...
179+
- "required": True,
180+
+ "required": False,
181+
...
182+
"ui": {"default_selected": "yes"}, # "yes", "no" or "not_needed"
183+
},
184+
...
185+
}
186+
```
163187

164188
With this option enabled, users can decide whether or not to request a DOI for their record. However, managing different versions of a record with and without DOIs can introduce complexities. Ideally, once a DOI is registered for a record, all subsequent versions should also have a DOI to avoid resolving to a version with a DOI, and creating confusion.
165189

docs/releases/v12/upgrade-v12.0.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -172,10 +172,11 @@ invenio domains create spammer
172172

173173
### New configuration variables
174174

175-
```bash
176-
COMMUNITIES_IDENTITIES_CACHE_REDIS_URL = "URI_TO_REDIS"
177-
USERS_RESOURCES_ADMINISTRATION_ENABLED = True
178-
THEME_SITENAME = "Project name for header and UI"
175+
These are the new configuration variables introduced in this release. Add them to your `invenio.cfg` as needed:
176+
177+
```python
178+
COMMUNITIES_IDENTITIES_CACHE_REDIS_URL = "URI_TO_REDIS" # Redis URL for caching community identities
179+
USERS_RESOURCES_ADMINISTRATION_ENABLED = True # Enables the users administration panel
179180
```
180181

181182
## Big Changes

docs/releases/v13/upgrade-v13.0.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,3 +241,18 @@ Failing to apply these changes may result in errors when accessing certain recor
241241

242242
#### Enhanced File Uploader (Uppy)
243243
If you plan to use the new Uppy file uploader, ensure that your Content Security Policy (CSP) settings are updated in your `invenio.cfg` as described in the [enhanced file uploader documentation](../../operate/customize/file-uploads/uploader.md#enhanced-file-uploader-uppy). Failing to update your CSP rules may prevent the uploader from functioning correctly.
244+
245+
#### New configuration variables
246+
247+
These are the new configuration variables introduced in this release. Make sure that you read the related documentation before enabling them. Add them to your `invenio.cfg` as needed:
248+
249+
```python
250+
# Enable FAIR Signposting
251+
APP_RDM_RECORD_LANDING_PAGE_FAIR_SIGNPOSTING_LEVEL_1_ENABLED = True
252+
# Enable Audit Logs
253+
AUDIT_LOGS_ENABLED = True
254+
# Manual setup required: enable Curation Checks
255+
CHECKS_ENABLED = True
256+
# Experiments: enable the new Uppy file uploader
257+
APP_RDM_DEPOSIT_NG_FILES_UI_ENABLED = True
258+
```

docs/releases/v13/version-v13.0.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ With v13, you can now enable support for FAIR Signposting level 1 and 2. See [th
124124
### Files uploader & S3-compatible storage
125125
The new file uploader, powered by Uppy (disabled by default), delivers a faster, more intuitive, and modern file upload experience. It also enables advanced features such as **multipart file transfers** with **S3-compatible** storage backends.
126126

127-
Learn more about [file uploaders](../../operate/customize/file-uploads/uploader.md), [S3-compatible storage](../../operate/customize/file-uploads/s3.md), and [file transfers](../../reference/file_transfer.md)
127+
Learn more about [file uploaders](../../operate/customize/file-uploads/uploader.md), [S3-compatible storage](../../operate/customize/file-uploads/s3.md), and [file transfers](../../reference/file_transfer.md).
128128

129129
### Jobs
130130
This release introduces a new Jobs feature, providing a comprehensive way to manage asynchronous tasks via the UI or REST API. Jobs are triggered via the admin UI or REST API, run using Celery, and support logging, argument validation, and result tracking. See the related documentation [here](../../use/administration.md#jobs).

0 commit comments

Comments
 (0)