Skip to content

Commit 5d4aaee

Browse files
committed
v13: cleanup pass on notes
1 parent ef10c2a commit 5d4aaee

File tree

7 files changed

+61
-58
lines changed

7 files changed

+61
-58
lines changed

docs/maintenance/architecture/curation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Curation checks
22

3+
_Introduced in v13_
4+
35
**Intended audience**
46

57
This guide is intended for maintainers and developers of InvenioRDM itself.

docs/operate/customize/dois.md

Lines changed: 6 additions & 5 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,14 +86,15 @@ 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
9696
RDM_ALLOW_EXTERNAL_DOI_VERSIONING = False
97+
```
9798

9899
#### Parent or Concept DOIs
99100

docs/operate/customize/require_community.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Require community for record publication
22

3+
_Introduced in v13_
4+
35
Institutional policies may require all published records to belong to at least one community. InvenioRDM enforces this requirement through the `RDM_COMMUNITY_REQUIRED_TO_PUBLISH` configuration parameter.
46
To activate this feature, open your `invenio.cfg` and add:
57

docs/operate/customize/vocabularies/funding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Create a new job called "Load Funders" in the Default queue with task "Load ROR
5050
sure to check the "active" checkbox and click the save button.
5151
5252
Then click the "Configure and run" button, select the "celery" queue, and put
53-
"1900-01-01" in the "Since" field. Click "Run now" and your affiliations will
53+
"1900-01-01" in the "Since" field. Click "Run now" and your funders will
5454
be loaded.
5555
5656
You can also use the "Schedule job" button to download the latest version of

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ Here is a quick summary of the myriad other improvements in this release:
130130
- Great improvements in bulk serialization performance
131131
- The communities REST endpoint accepts both UUID and slug in the URL
132132
- Many new configuration variables (e.g., `COMMUNITIES_SEARCH_SORT_BY_VERIFIED`) to tune your instance
133+
- The new `generator` HTML `meta` tag identifies the repository technology. This is used by services like [OpenDOAR](https://opendoar.ac.uk/) to correctly catalog open access repositories.
133134
- ...and many more bug fixes!
134135

135136
## Breaking changes

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

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,6 @@ invenio-cli, version 1.8.0
2626
In case you are not inside a virtual environment, make sure that you prefix each `invenio`
2727
command with `pipenv run`.
2828

29-
**Local development**
30-
31-
Changing the Python version in your development environment highly
32-
depends on your setup, so we won't cover it here.
33-
One way would be to use [PyEnv](https://github.com/pyenv/pyenv).
34-
35-
!!! warning "Risk of losing data"
36-
37-
Your virtual environment folder a.k.a., `venv` folder, may contain uploaded files. If you kept the default
38-
location, it is in `<venv folder>/var/instance/data`. If you need to keep those files,
39-
make sure you copy them over to the new `venv` folder in the same location.
40-
The command `invenio files location list` shows the file upload location.
41-
42-
If you upgraded your python version, you should recreate your virtual environment before
43-
running `invenio-cli` or `pipenv` commands below.
44-
4529
### Upgrade InvenioRDM
4630

4731
#### Requirements
@@ -75,6 +59,13 @@ This approach will create a new virtual environment and leaves the v12 one as-is
7559
If you are using a docker image on your production instance this will be the
7660
option you choose.
7761

62+
!!! warning "Risk of losing data"
63+
64+
Your virtual environment folder a.k.a., `venv` folder, may contain uploaded files. If you kept the default
65+
location, it is in `<venv folder>/var/instance/data`. If you need to keep those files,
66+
make sure you copy them over to the new `venv` folder in the same location.
67+
The command `invenio files location list` shows the file upload location.
68+
7869
##### Step 1
7970

8071
- create a new virtual environment
@@ -193,7 +184,7 @@ If you choose to delete and re-create your search cluster as part of the upgrade
193184
Be sure to repeat the [Rebuild search indices](#rebuild-search-indices) step to ensure your system is fully functional.
194185

195186
#### Jobs
196-
The new Jobs feature uses a custom celery task scheduler which requires a separate celery beat. See the [related documentation](../../operate/customize/jobs.md#scheduler) on how to add it or [this change](https://github.com/inveniosoftware/cookiecutter-invenio-rdm/pull/314) in the InvenioRDM boilerplate for reference.
187+
The new Jobs feature uses a custom celery task scheduler which requires a separate celery beat. See the [related documentation](../../operate/customize/jobs.md#scheduler) or [the scheduler service](https://github.com/inveniosoftware/cookiecutter-invenio-rdm/blob/ff6c652091d56e7a8aa0a90487f91352f70c4e33/%7B%7Bcookiecutter.project_shortname%7D%7D/docker-compose.full.yml) in the InvenioRDM boilerplate for how to add it.
197188

198189
!!! note
199190
Be sure to run this additional Celery beat scheduler in your production or deployed environments. Without it, scheduled and on-demand jobs will not be executed.
@@ -216,10 +207,17 @@ To resolve this, simply add a custom [`types`](https://nginx.org/en/docs/http/ng
216207

217208
### Optional changes
218209

219-
#### Deprecated configurations
210+
#### Deprecations
211+
212+
*`APP_ALLOWED_HOSTS`*
213+
220214
With the upgrade to Flask version 3, the configuration variable `APP_ALLOWED_HOSTS` has been renamed to `TRUSTED_HOSTS`. The value remains unchanged.
221215
You should review your `invenio.cfg`, environment variables, and deployment configuration for any occurrences of the old variable name.
222-
It is recommended to update all references to `TRUSTED_HOSTS` to avoid deprecation warnings in the console.
216+
It is recommended to update all references to `TRUSTED_HOSTS` to avoid deprecation warnings in the console and prepare for its eventual complete removal.
217+
218+
*`invenio_records_resources.services.Link`*
219+
220+
Usage of `invenio_records_resources.services.Link` is deprecated in favor of `invenio_records_resources.services.EndpointLink` for InvenioRDM links and `invenio_records_resources.services.ExternalLink` for external third-party links. Replace instances of `Link` in your custom code, if any, appropriately. `Link` will be removed in a future major InvenioRDM release.
223221

224222
#### Display versions in administration panel
225223
As described in the [release notes](./version-v13.0.0.md#miscellaneous-additions), you can now display the versions of your installed modules directly in the Administration panel.

0 commit comments

Comments
 (0)