adding 6.1 release notes and removing .md files #10166
Conversation
|
|
||
| ## Detailed Release Highlights, New Features and Use Case Scenarios | ||
|
|
||
| ### Dataverse installation can be now be configured to allow out-of-band upload |
There was a problem hiding this comment.
This heading is the first one without Title Case. Let's be consistent. We can ditch title case everywhere or use it everywhere.
There was a problem hiding this comment.
Is this still an issue. I would like to get the formatting right so we can make a template for future release notes?
|
|
||
| Upgrading requires a maintenance window and downtime. Please plan ahead, create backups of your database, etc. | ||
|
|
||
| These instructions assume that you've already upgraded through all the 5.x releases and are now running Dataverse 6.0. |
There was a problem hiding this comment.
Where are the upgrade instructions?
There was a problem hiding this comment.
I didn't see any upgrade instructions. If there are none I will remove this
There was a problem hiding this comment.
@sekmiller is working on this ❤️
Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>
| - hasBeenDeleted (/api/files/{id}/hasBeenDeleted): Know if a particular file that existed in a previous version of the dataset no longer exists in the latest version. | ||
| - deaccessionDataset (/api/datasets/{id}/versions/{versionId}/deaccession): version deaccessioning through API (Given a dataset and a version). | ||
| - getZipDownloadLimit (/api/info/zipDownloadLimit): Get the configured zip file download limit. The response contains the long value of the limit in bytes. | ||
| - getMaxEmbargoDurationInMonths (/api/info/settings/:MaxEmbargoDurationInMonths): Get the maximum embargo duration in months, if available, configured through the database setting :MaxEmbargoDurationInMonths. |
There was a problem hiding this comment.
Is this going away with the new settings API?
There was a problem hiding this comment.
I hate removing APIs. If we do, it should go in the API changelog. Perhaps it would be a good idea to indicate that we plan to replace this API with that more general solution, probably in 6.2.
| - when files are requested to be included, some database lookup optimizations have been added to improve the performance on datasets with large numbers of files. | ||
|
|
||
| This is reflected in the [Dataset Versions API](https://guides.dataverse.org/en/9763-lookup-optimizations/api/native-api.html#dataset-versions-api) section of the Guide. | ||
| ### The following API endpoints have been added: |
There was a problem hiding this comment.
Are all of these SPA-related? I'm wondering if pointing out that these are all for existing functionality that is now being exposed via API versus new functionality would help (anyone not using the API might skip this section, and it would advertise SPA progress a bit).
| - Functionality has been added to help validate dataset JSON prior to dataset creation. There are two new API endpoints in this release. The first takes in a collection alias and returns a custom dataset schema based on the required fields of the collection. The second takes in a collection alias and a dataset JSON file and does an automated validation of the JSON file against the custom schema for the collection. In this release funtionality is limited to json format validation and validating required elements. Future releases will address field types, controlled vocabulary, etc. (Issue #9464 and #9465) | ||
|
|
||
| ### Solr Improvements | ||
| - As of this release application-side support is added for the "circuit breaker" mechanism in Solr that makes it drop requests more gracefully when the search engine is experiencing load issues. |
There was a problem hiding this comment.
There were other performance improvements as well right? (Were there non-Solr performance improvements in this release too?) Would be good to point it out.
There was a problem hiding this comment.
The performance improvements I can think of are the enhanced /versions apis. But those are mentioned already.
Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>
Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>
|
I just want to put it on record that there is a long release note in the Globus PR #10162 that I'm still looking into. And there's otherwise a lot of good stuff in that PR and it should definitely be mentioned in the release note. |
out of band setting previously added
| - We have started maintaining an API changelog of breaking changes: https://guides.dataverse.org/en/6.1/api/changelog.html | ||
| See also #10060. |
There was a problem hiding this comment.
I just pushed an update to make the API changelog only about breaking changes. This will be much easier to maintain. I also called it experimental and said we'd like feedback. Here's how it looks as of this writing:
| #### Using MicroProfile Config for provisioning | ||
|
|
||
| With this release it is possible to provision a single OIDC-based authentication provider | ||
| by using MicroProfile Config instead of or in addition to the classic Admin API provisioning. |
There was a problem hiding this comment.
If you look at the raw file in NetBeans, in most cases we're letting the text run off the page without any line breaks. Does it matter? Do we need to make sure it's consistent?
There was a problem hiding this comment.
It doesn't matter for the final HTML output.
|
|
||
| #### Adding PKCE Support | ||
|
|
||
| [This PR adds PKCE support for OIDC providers](https://github.com/IQSS/dataverse/pull/9273) |
There was a problem hiding this comment.
Do we need these square brackets?
There was a problem hiding this comment.
I ended up removing this whole line and linking to the guides and that PR lower down.
What this PR does / why we need it: Supplies release notes for v 6.1
Which issue(s) this PR closes:#10151
Closes ##10151
Special notes for your reviewer:
Suggestions on how to test this:
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Is there a release notes update needed for this change?:
Additional documentation: