Skip to content

Commit 0027c42

Browse files
committed
docs-reorg: reorganize 'Releases' section - skip v13
1 parent ef5de29 commit 0027c42

File tree

137 files changed

+163
-313
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

137 files changed

+163
-313
lines changed

docs/develop/architecture/communities.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This guide is intended for maintainers and developers of InvenioRDM itself.
66

77
**Scope**
88

9-
The guide provides a high-level architectural overview of the communities
9+
The guide provides a high-level architectural overview of the communities
1010
module for InvenioRDM.
1111

1212
## Community visibility
@@ -16,7 +16,7 @@ Communities visibility can be set to either:
1616
- *public* - any user can see the community
1717
- *restricted* - only community members can see the community
1818

19-
![Create a community](../../releases/versions/v9.0/community-create.png)
19+
![Create a community](../../releases/v9/imgs/community-create.png)
2020

2121
Both public and restricted communities can contain restricted records, and thus
2222
not all records in a public community may be visible to everyone. A restricted
@@ -30,7 +30,7 @@ communities to ensure a consistent user experience across all communities.
3030
A community role translates into a set of permissions. The roles are
3131
configurable to ensure that they can be tailored to the needs of an instance,
3232
as well as allow for customizations. For example, one instance may use
33-
"curator" and another may use "editor" as a role because it suits
33+
"curator" and another may use "editor" as a role because it suits
3434
their use case better.
3535

3636
By default the following community roles are defined:

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ template: frontpage.html
77

88
!!! tip "August 1st, 2024: InvenioRDM v12.0 Long-term support available! ✨"
99

10-
🚀 Read the full [release notes](releases/versions/version-v12.0.0.md).
10+
🚀 Read the full [release notes](releases/v12/version-v12.0.0.md).

docs/releases/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ We aim to have a quarterly release cycle, to push out new features as fast as po
77

88
Only releases designated **Long-Term Support (LTS)** releases are supported for production services.
99

10-
Our aim is to ensure that users of InvenioRDM follows our latest releases by making the upgrade process a seamless experience.
10+
Our aim is to ensure that users of InvenioRDM follow our latest releases by making the upgrade process a seamless experience.
1111

1212

1313
## Policies
1414

1515
- [Maintenance policy](maintenance-policy.md)
1616
- [Security policy](security-policy.md)
17-
- [Upgrade policy](upgrading/index.md)
17+
- [Upgrade policy](upgrade-policy.md)

docs/releases/upgrading/migrate-docker-images.md renamed to docs/releases/migrate-docker-images.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The base Docker images for InvenioRDM v9.x and v10.x were hosted on Docker Hub,
1010
1111
Depending on what will happen, building the Docker images on InvenioRDM v9/v10 with the commands `invenio-cli containers ` might fail.
1212

13-
With InvenioRDM v11, released on January 26, 2023, we have migrated the Docker images to the CERN registry, see [here the release notes](../versions/version-v11.0.0.md#deployment). This was done for a couple of reasons:
13+
With InvenioRDM v11, released on January 26, 2023, we have migrated the Docker images to the CERN registry, see [here the release notes](v11/version-v11.0.0.md#deployment). This was done for a couple of reasons:
1414

1515
1. Avoid [Docker Hub rate limits](https://www.docker.com/increase-rate-limits/).
1616
2. Take advantage of the automatic security scan provided by the CERN registry.
@@ -75,7 +75,7 @@ There are two possible ways to migrate:
7575
+ FROM registry.cern.ch/inveniosoftware/almalinux:1
7676
```
7777

78-
In this last case of AlmaLinux, make sure that you are running Python 3.9, which is the Python version that comes with the `almalinux` image. You should follow the [v11 Python version change](./upgrade-v11.0.md#python-version-change) instructions to make sure that you are taking the necessary steps.
78+
In this last case of AlmaLinux, make sure that you are running Python 3.9, which is the Python version that comes with the `almalinux` image. You should follow the [v11 Python version change](v11/upgrade-v11.0.md#python-version-change) instructions to make sure that you are taking the necessary steps.
7979

8080
!!! warning "Test!"
8181
The change of the base Docker image can lead to unexpected issues. We recommend testing your instance extensively in a test environment, before deployment to production.
File renamed without changes.

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

Lines changed: 0 additions & 160 deletions
This file was deleted.

docs/releases/versions/version-v1.0.0.md renamed to docs/releases/v1/version-v1.0.0.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,19 +52,19 @@ The deposit form now has a new protection widget that allows you to deposit reco
5252

5353
Below are some examples of how this now looks in the deposit form:
5454

55-
![](v1.0/1_access_control_examples.png)
55+
![](imgs/1_access_control_examples.png)
5656

5757
**Restricted records and files**
5858

5959
Restricted records and files are only visible for the owner (the user who deposited the material). This means that e.g. a restricted record will not show up in the search results of other users.
6060

6161
User without access (no files and no edit button visible):
6262

63-
![](v1.0/2_access_control_restricted_files.png)
63+
![](imgs/2_access_control_restricted_files.png)
6464

6565
User with access (files and edit button visible):
6666

67-
![](v1.0/3_access_control_owner.png)
67+
![](imgs/3_access_control_owner.png)
6868

6969
Note, that the message "Sorry, the files are restricted!" is a temporary message, until we have a solution for the access badge (see next section).
7070

@@ -74,11 +74,11 @@ We have temporarily removed the access status badge (see before/after screenshot
7474

7575
Before:
7676

77-
![](v1.0/4_access_badge_before.png)
77+
![](imgs/4_access_badge_before.png)
7878

7979
After:
8080

81-
![](v1.0/5_access_badge_after.png)
81+
![](imgs/5_access_badge_after.png)
8282

8383
**Limitation: Embargo feature**
8484

@@ -118,11 +118,11 @@ We have fixed a large number of small styling and consistentcy issues. Still som
118118

119119
The list uploads page now has a nice greeting for first time users:
120120

121-
![](v1.0/6_list_uploads_empty.png)
121+
![](imgs/6_list_uploads_empty.png)
122122

123123
Also, the overall styling of the page was improved:
124124

125-
![](v1.0/7_list_uploads_styling.png)
125+
![](imgs/7_list_uploads_styling.png)
126126

127127
**Search guide**
128128

docs/releases/versions/version-v10.0.0.md renamed to docs/releases/v10/version-v10.0.0.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ You can also extend the default components or implement your owns. To get more i
2626

2727
Below, an example of the upload form with custom fields related to software. You can test them out in the [demo site upload form](https://inveniordm.web.cern.ch/uploads/new).
2828

29-
![](img/../v10.0/custom_fields.png)
29+
![](imgs/custom_fields.png)
3030

3131
#### Community settings page
3232

3333
Custom fields will be displayed at the bottom of the community's settings page.
3434

35-
![](img/../v10.0/custom_fields_communities.png)
35+
![](imgs/custom_fields_communities.png)
3636

3737
When a community field is required, it will be also displayed in the form to [create a new community](https://inveniordm.web.cern.ch/communities/new).
3838

@@ -42,7 +42,7 @@ The new administration panel provides a modern, clean and easy to use interface.
4242

4343
This release comes with the first new OAI-PMH administration view, which allows to manage or create OAI-PMH sets.
4444

45-
![](img/../v10.0/backoffice_oai_sets.png)
45+
![](imgs/backoffice_oai_sets.png)
4646

4747
Some OAI-PMH sets are automatically created when a new community is added. These system created sets are blocked from edition in the administration view to preserve the data sets integrity.
4848

@@ -60,15 +60,15 @@ With the [change of license](https://www.elastic.co/pricing/faq/licensing) of El
6060

6161
While Elasticsearch v7 is still supported, Elasticsearch v6 support has been removed. However, Elasticsearch support will be removed in a future version of InvenioRDM.
6262

63-
We recommend migrating directly to OpenSearch v2, OpenSearch v1 [end of life](https://endoflife.date/opensearch) is rapidly approaching. See the [upgrade guide](../upgrading/upgrade-v10.0.md) for more information.
63+
We recommend migrating directly to OpenSearch v2, OpenSearch v1 [end of life](https://endoflife.date/opensearch) is rapidly approaching. See the [upgrade guide](./upgrade-v10.0.md) for more information.
6464

6565
You can read more on how to setup an OpenSearch cluster in the [official documentation](https://opensearch.org/docs/latest/opensearch/install/index/). [Invenio Helm Charts](https://github.com/inveniosoftware/helm-invenio/) have been updated adding support for OpenSearch, but the configuration will setup a demo cluster and it should **not be used in production**. OpenSearch provides [official Helm charts](https://opensearch.org/docs/latest/opensearch/install/helm/) suitable for production environments.
6666

6767
## Changes
6868

6969
### Breaking changes
7070

71-
- Elasticsearch 6 support has been removed. If you are using InvenioRDM with Elasticsearch 6, you can migrate to Elasticsearch 7 or directly to OpenSearch. See the [upgrade guide](../upgrading/upgrade-v10.0.md) for more information.
71+
- Elasticsearch 6 support has been removed. If you are using InvenioRDM with Elasticsearch 6, you can migrate to Elasticsearch 7 or directly to OpenSearch. See the [upgrade guide](./upgrade-v10.0.md) for more information.
7272
- The configuration variable `INVENIO_SEARCH_ELASTIC_HOSTS` has been deprecated (but non-breaking) and it will be removed in the following releases. Please change its name to `INVENIO_SEARCH_HOSTS`. This variable is most probably also used in your deployment environments.
7373
- The following changes should not affect the majority of the users. We recommend to verify if any usage can be found in customisations or modules:
7474
- In [Invenio-Indexer](https://github.com/inveniosoftware/invenio-indexer), the param `es_bulk_kwargs` in the class `RecordIndexer` has been renamed to `search_bulk_kwargs`. The method `record_to_index` and `schema_to_index` now return only the index and not a tuple with index and doc type. The configuration variable `INDEXER_DEFAULT_DOC_TYPE` is now removed.
@@ -81,13 +81,13 @@ You can read more on how to setup an OpenSearch cluster in the [official documen
8181

8282
**Strict search mappings**
8383

84-
Search mappings have been made strict, which means that no unknown fields will be accepted. Before, no errors were being thrown. If you had custom record dumpers you might need to add custom fields and rebuild the indices. See the [upgrade guide](../upgrading/upgrade-v10.0.md) for more information.
84+
Search mappings have been made strict, which means that no unknown fields will be accepted. Before, no errors were being thrown. If you had custom record dumpers you might need to add custom fields and rebuild the indices. See the [upgrade guide](./upgrade-v10.0.md) for more information.
8585

8686
**Deposit form publish modal warning text customization**
8787

8888
The warning text shown in the modal during the publish/submit-for-review action can now be extended via the `APP_RDM_DEPOSIT_FORM_PUBLISH_MODAL_EXTRA` config variable. You can pass text or html there and the result will look like the following:
8989

90-
![Customize publish modal warning text](./v10.0/publish_modal_text_customize.png)
90+
![Customize publish modal warning text](imgs/publish_modal_text_customize.png)
9191

9292
## Deprecations
9393

@@ -99,7 +99,7 @@ With this release, communities custom fields are not displayed in the community
9999

100100
## Upgrading to v10.0
101101

102-
We support upgrading from v9.1 to v10 Please see the [upgrade notice](../upgrading/upgrade-v10.0.md).
102+
We support upgrading from v9.1 to v10 Please see the [upgrade notice](./upgrade-v10.0.md).
103103

104104
## Maintenance policy
105105

docs/releases/versions/version-v11.0.0.md renamed to docs/releases/v11/version-v11.0.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Support for Elasticsearch v7 is deprecated and it will be removed in a future re
167167

168168
## Upgrading to v11.0
169169

170-
We support upgrading from v10 to v11. Please see the [upgrade notice](../upgrading/upgrade-v11.0.md).
170+
We support upgrading from v10 to v11. Please see the [upgrade notice](./upgrade-v11.0.md).
171171

172172
## Maintenance policy
173173

0 commit comments

Comments
 (0)