Skip to content

Commit d32ea2d

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

File tree

3 files changed

+19
-41
lines changed

3 files changed

+19
-41
lines changed

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/v13/upgrade-v13.0.md

Lines changed: 1 addition & 17 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
@@ -193,7 +177,7 @@ If you choose to delete and re-create your search cluster as part of the upgrade
193177
Be sure to repeat the [Rebuild search indices](#rebuild-search-indices) step to ensure your system is fully functional.
194178

195179
#### 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.
180+
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/master/%7B%7Bcookiecutter.project_shortname%7D%7D/docker-compose.full.yml) in the InvenioRDM boilerplate for how to add it.
197181

198182
!!! note
199183
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.

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

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
_2025-07-21_
44

5-
We're happy to announce the release of InvenioRDM v13.0! Version 13 will be maintained until at least 6 months following the next release. Visit our maintenance policy page to learn more.
5+
We're happy to announce the release of InvenioRDM v13.0! Version 13 will be maintained until at least 6 months following the next release. Visit our [maintenance policy page](../maintenance-policy.md) to learn more.
66

77
## Try it
88

@@ -48,7 +48,7 @@ Communities can now have their own theming with a custom font and colors, which
4848

4949
![A default community and two themed communities on Zenodo](imgs/themed-communities.png)
5050

51-
Themed communities benefit from a custom homepage, defined by changing its HTML template.
51+
Themed communities can have a custom homepage defined by overriding the default Jinja template.
5252

5353
Read more about the [themes communities feature](../../operate/customize/look-and-feel/themed_communities.md).
5454

@@ -68,15 +68,17 @@ Collections introduce a powerful new way to organize and curate records within y
6868
Collections provide dedicated pages showing all records matching specific criteria.
6969
///
7070

71-
**Hierarchical organization**
71+
*Hierarchical organization*
72+
7273
Collections allow you to define hierarchical groupings of records, enabling users to browse content by subject, resource type, funding program, or any other metadata field.
7374

7475
![Community "Browse" tab showing hierachical collections based on subjects](imgs/collection-browse.png)
7576
/// caption
7677
The collection browser provides an organized view of all available collections within a community.
7778
///
7879

79-
**Common use cases**
80+
*Common use cases*
81+
8082
- Group content by research disciplines using a hierarchical vocabulary
8183
- Organize historical records by publication date
8284
- Organize records by funding programs (Horizon 2020, NSF, institutional grants)
@@ -97,7 +99,7 @@ Curation checks in Zenodo's EU Open Research Repository
9799

98100
Read the detailed documentation for [Curation checks](../../operate/customize/curation-checks.md).
99101

100-
### Customizable compliance info when publishing
102+
### Customizable compliance information when publishing
101103
You can now fully customize the compliance information and checkboxes that users must acknowledge when publishing a record. This makes it easy to tailor the publishing workflow to your organization's policies or legal requirements.
102104

103105
![Publish modal with extra checkbox](../../operate/customize/imgs/compliance_checkboxes.png)
@@ -110,11 +112,11 @@ You can now let users to choose if they need a DOI or not when uploading. See ho
110112
![DOIs on demand](../../operate/customize/imgs/dois-on-demand.jpg)
111113

112114
### Extra PIDs schemes
113-
InvenioRDM v13 allows you to extend the list of existing schemes for persistent identifiers to detect, validate and add support for your owns.
115+
InvenioRDM v13 allows you to extend the list of existing persistent identifier schemes to detect, validate and support any additional ones you want.
114116

115117
![Extra PID schemes](../../operate/customize/metadata/imgs/custom_pids_schemes.jpg)
116118

117-
See the [related documentation](../../operate/customize/metadata/custom_pids_schemes.md) how to add your own custom schemes.
119+
See the [related documentation](../../operate/customize/metadata/custom_pids_schemes.md) for how to add your own custom schemes.
118120

119121
Under the hood, the Invenio [idutils](https://github.com/inveniosoftware/idutils) module handles validation and normalization of persistent identifiers used in scholarly communication, and existing customizations may be affected by changes in v13. The module has been restructured to use a configurable scheme system with a new entrypoint mechanism for registering your own identifier schemes.
120122

@@ -134,7 +136,7 @@ You can now setup jobs to automatically and recurrently fetch ORCID and ROR late
134136

135137
For ORCID, read more on the [names vocabulary](../../operate/customize/vocabularies/names.md#using-orcid-public-data-sync) documentation page.
136138

137-
With the ROR job, you can automatically load funders or affiliations vocabulary from the InvenioRDM administration panel, and schedule updates with new ROR releases. Instructions can be found on the [affiliations vocabulary](../../operate/customize/vocabularies/affiliations.md) documentation page.
139+
With the ROR job, you can automatically load the affiliations or funders vocabulary from the InvenioRDM administration panel, and schedule updates with new ROR releases. Instructions can be found on the [affiliations](../../operate/customize/vocabularies/affiliations.md) and [funding](../../operate/customize/vocabularies/funding.md) documentation pages respectively.
138140
We have also upgraded the integration with ROR to version 2.0 and enhanced the metadata to include organization aliases, status, types, locations, and acronyms, making it easier to find the correct organization or funders.
139141

140142
#### EuroSciVoc subjects
@@ -159,7 +161,7 @@ We have introduced new metadata fields that will allow you to capture more usefu
159161
The v13 release features an upgraded PDF previewer, now powered by [PDF.js v4](https://github.com/mozilla/pdf.js). This update resolves previous issues with failed previews for certain PDF files, providing a more reliable and seamless viewing experience.
160162

161163
### Requests sharing
162-
When a record is shared, the review request is now also accessible. We have introduced a new search filter in `My Dashboard`, to easily find records shared with me.
164+
When a record is shared, the review request is now also accessible. We have introduced a new search filter in `My Dashboard`, to easily find records shared with you.
163165

164166
![Shared with me](./imgs/my-dashboard-shared-with-me.jpg)
165167

@@ -169,12 +171,12 @@ Both users and records search have been enhanced to return more accurate results
169171
Creators, affiliations and funders autocompletion has been improved so that suggestions appear faster and better match what you type.
170172

171173
### Sitemaps
172-
InvenioRDM v13 introduces the automatic generation of sitemaps to help search engines and other crawlers discovering and indexing your repository's content. Sitemaps are even automatically linked in your `robots.txt`.
174+
InvenioRDM v13 introduces the automatic generation of sitemaps to help search engines and other crawlers discover and index your repository's content. Sitemaps are even automatically linked in your `robots.txt`.
173175

174-
See the [related documentation](../../operate/customize/sitemaps.md) to learn how to configure it.
176+
See the [related documentation](../../operate/customize/sitemaps.md) to learn how to configure their generation.
175177

176178
### Miscellaneous additions
177-
Here is a quick summary of the myriad other improvements in this release:
179+
Here is a quick summary of the myriad of other improvements in this release:
178180

179181
- A convenient "Copy" button has been added next to the DOI (when enabled) and export formats, allowing users to instantly copy these values to their clipboard with a single click without manually selecting or exporting the content:
180182
![Copy button for DOI](imgs/copy-button-doi.jpg)
@@ -200,9 +202,8 @@ Here is a quick summary of the myriad other improvements in this release:
200202
- Following the [latest COUNTER spec](https://www.countermetrics.org/code-of-practice/), the [list of robots and machines](https://github.com/inveniosoftware/counter-robots) have been updated to ensure the stats are counted on human usage.
201203
- Logging: the Flask root logger level has been changed from `undefined` to `DEBUG`. This enables all log messages to pass through by default, instead of being blocked. If you have implemented custom logging handlers, ensure that you have defined the logging level and verify your logging verbosity in deployed environments to avoid excessive logs.
202204
- The issue related to storage quota per record for a given user has been solved. You can now define different storage quotas per record.
203-
- InvenioRDM v13 introduces the `generator` HTML `meta` tag to identify the repository technology. This is used by services like [OpenDOAR](https://opendoar.ac.uk/) to correctly catalog open access repositories.
204-
The generator string will be `InvenioRDM v13.0`. You can change it in your `invenio.cfg` by overriding the variable `THEME_GENERATOR` or setting it to `None` to disable the meta tag.
205205
- MathJax: when enabled, it will now render mathematical formulas also in the landing page citation box, search results and request's comments pages.
206+
- Easier link generation: it's now possible to use `from invenio_base import invenio_url_for` to generate API links in the UI application and vice versa. When configuring services, `from invenio_records_resources.services import EndpointLink` now replaces `Link` which establishes a single source of truth for links.
206207
- ...and many more bug fixes!
207208

208209
### Experimental
@@ -216,6 +217,7 @@ These tools are **disabled by default** and will be tested further in the coming
216217
- The integration with the new ROR schema v2 requires to re-import both the affiliations and funders vocabularies. See the [upgrade guide](upgrade-v13.0.md#updated-affiliations-and-funders) for more information.
217218
- The upgrade of the PDF previewer requires a small change to the webserver configuration. See the [upgrade guide](upgrade-v13.0.md) for more information.
218219
- Direct Python imports of identifier schemes (e.g., `from idutils.isbn import normalize_isbn`) are now deprecated and will be removed in future versions. If you have custom code that directly imports scheme modules, you'll need to update it to use the new API.
220+
- Usage of `from invenio_records_resources import Link` is deprecated in favor of `EndpointLink` for InvenioRDM links and `ExternalLink` for external third-party links. `Link` will be removed in a future major InvenioRDM release.
219221

220222
## Requirements
221223

@@ -243,7 +245,7 @@ The development work of this impressive release wouldn't have been possible with
243245
- Alex Ioannidis
244246
- Alzbeta Pokorna
245247
- Anika Churilova
246-
- Austin
248+
- Austin Sharp
247249
- Brian Kelly
248250
- Carlin MacKenzie
249251
- Christoph Ladurner
@@ -254,16 +256,13 @@ The development work of this impressive release wouldn't have been possible with
254256
- ducica
255257
- Eduard Nitu
256258
- Emil Dandanell Agerschou
257-
- enitu
258259
- Eric Newman
259260
- Eric Phetteplace
260261
- Esteban J. G. Gabancho
261262
- Fatimah Zulfiqar
262263
- Felipe Carlos
263264
- Florian Gantner
264265
- Furkan Kalkan
265-
- furkankalkan
266-
- Gantner, Florian Klaus
267266
- Guillaume Viger
268267
- Hrafn Malmquist
269268
- Ian W. Scott
@@ -276,7 +275,6 @@ The development work of this impressive release wouldn't have been possible with
276275
- Martin Fenner
277276
- Martin Obersteiner
278277
- Matt Carson
279-
- Max
280278
- Maximilian Moser
281279
- mb-wali
282280
- Michael Groh
@@ -288,15 +286,11 @@ The development work of this impressive release wouldn't have been possible with
288286
- Pablo Saiz
289287
- Pablo Tamarit
290288
- Panna Liptak
291-
- phette23
292-
- psaiz
293-
- rekt-hard
294289
- roll
295290
- Saksham Arora
296291
- Sam Arbid
297292
- Sarah Wiechers
298293
- Tom Morrell
299-
- utnapischtim
300294
- Werner Greßhoff
301295
- Will Riley
302296
- Yash Lamba

0 commit comments

Comments
 (0)