Merge pull request #7390 from IQSS/7358-5.2-Release-Notes

5.2 release notes

doc/release-notes/5.2-release-notes.md

@@ -0,0 +1,105 @@
+# Dataverse 5.2
+
+This release brings new features, enhancements, and bug fixes to Dataverse. Thank you to all of the community members who contributed code, suggestions, bug reports, and other assistance across the project.
+
+## Release Highlights
+
+### File Preview When Guestbooks or Terms Exist
+
+Previously, file preview was only available when files were publicly downloadable. Now if a guestbook or terms (or both) are configured for the dataset, they will be shown in the Preview tab and once they are agreed to, the file preview will appear (#6919).
+
+### Preview Only External Tools
+
+A new external tool type called "preview" has been added that prevents the tool from being displayed under "Explore Options" under the "Access File" button on the file landing page (#6919).
+
+### Dataset Page Edit Options Consolidation
+
+As part of the continued effort to redesign the Dataset and File pages, some of the edit options for a file on the dataset page are being moved to a "kebab" to allow for better consistency and future scalability.
+
+### Google Cloud Archiver
+
+Dataverse Bags can now be sent to a bucket in Google Cloud, including those in the "Coldline" storage class, which provides less expensive but slower access.
+
+## Major Use Cases
+
+Newly-supported use cases in this release include:
+
+- Users can now preview files that have a guestbook or terms. (Issue #6919, PR #7369)
+- External tool developers can indicate that their tool is "preview only". (Issue #6919, PR #7369)
+- Dataverse Administrators can set up a regular export to Google Cloud so that the installation's data is preserved (Issue #7140, PR #7292)
+- Dataverse Administrators can use a regex when defining a group (Issue #7344, PR #7351)
+- External Tool Developers can use a new API endpoint to retrieve a user's information (Issue #7307, PR #7345)
+
+## Notes for Dataverse Installation Administrators
+
+### Converting Explore External Tools to Preview Only
+
+When the war file is deployed, a SQL migration script will convert [dataverse-previewers][] to have both "explore" and "preview" types so that they will continue to be displayed in the Preview tab.
+
+If you would prefer that these tools be preview only, you can delete the tools, adjust the JSON manifests (changing "explore" to "preview"), and re-add them.
+
+[dataverse-previewers]: https://github.com/GlobalDataverseCommunityConsortium/dataverse-previewers
+
+### New Database Settings and JVM Options
+
+Installations integrating with Google Cloud Archiver will need to use two new database settings:
+
+- :GoogleCloudProject - the name of the project managing the bucket
+- :GoogleCloudBucket - the name of the bucket to use
+
+For more information, see the Google Cloud Configuration section of the [Installation Guide](https://guides.dataverse.org/en/5.2/installation/)
+
+### Automation of Make Data Count Scripts
+
+Scripts have been added in order to automate Make Data Count processing. For more information, see the Make Data Count section of the [Admin Guide](https://guides.dataverse.org/en/5.2/admin/).
+
+## Notes for Tool Developers and Integrators
+
+### Preview Only External Tools, "hasPreviewMode"
+
+A new external tool type called "preview" has been added that prevents the tool from being displayed under "Explore Options" under the "Access File" button on the file landing page (#6919). This "preview" type replaces "hasPreviewMode", which has been removed.
+
+### Multiple Types for External Tools
+
+External tools now support multiple types. In practice, the types "explore" and "preview" are the only combination that makes a difference in the UI as opposed to only having only one or the other type (see "preview only" above). Multiple types are specified in the JSON manifest with an array in "types". The older, single "type" is still supported but should be considered deprecated.
+
+### User Information Endpoint
+
+New API endpoint to retrieve user info so that tools can email users if needed.
+
+## Complete List of Changes
+
+For the complete list of code changes in this release, see the [5.2 Milestone](https://github.com/IQSS/dataverse/milestone/92?closed=1) in Github.
+
+For help with upgrading, installing, or general questions please post to the [Dataverse Google Group](https://groups.google.com/forum/#!forum/dataverse-community) or email support@dataverse.org.
+
+## Installation
+
+If this is a new installation, please see our [Installation Guide](https://guides.dataverse.org/en/5.2/installation/).
+
+## Upgrade Instructions
+
+0\. These instructions assume that you've already successfully upgraded from Dataverse 4.x to  Dataverse 5 following the instructions in the [Dataverse 5 Release Notes](https://github.com/IQSS/dataverse/releases/tag/v5.0).
+
+1\. Undeploy the previous version.
+
+- `<payara install path>/bin/asadmin list-applications`
+- `<payara install path>/bin/asadmin undeploy dataverse<-version>`
+
+(where `<payara install path>` is where Payara 5 is installed, for example: `/usr/local/payara5`)
+
+2\. Stop payara and remove the generated directory, start.
+
+- `service payara stop`
+- remove the generated directory: 
+`rm -rf <payara install path>/payara/domains/domain1/generated`
+- `service payara start`
+
+3\. Deploy this version.
+
+- `<payara install path>/bin/asadmin deploy dataverse-5.2.war`
+
+4\. Restart payara
+
+- `service payara stop`
+- `service payara start`