From ea214bef210e29fc6d4c94c7cd4f492a9e02ac9d Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Fri, 18 Oct 2019 13:35:41 -0400 Subject: [PATCH 01/16] new file, stub out initial doc --- doc/release-notes/4.18-release-notes.md | 110 ++++++++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100644 doc/release-notes/4.18-release-notes.md diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md new file mode 100644 index 00000000000..33ee3e1b758 --- /dev/null +++ b/doc/release-notes/4.18-release-notes.md @@ -0,0 +1,110 @@ +# Dataverse 4.17 + +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 + +### Dataset Level Explore Tools + +Tools that integrate with Dataverse can now be launched from the dataset page! This makes it possible to develop and add tools that work across the entire dataset instead of single files. Tools to verify reproducibility and allow researchers to compute on an entire dataset will take advantage of this new infrastructure. + +### Performance Enhancements + +Dataverse now allows installation administrators to configure the session timeout for logged in users using the new `:LoginSessionTimeout` setting. (Session length for anonymous users has been reduced from 24 hours to 10 minutes.) Setting this lower will release system resources as configured and will result in better performance (less memory use) throughout a Dataverse installation. + +Dataverse and Dataset pages have also been optimized to discard more of the objects they allocate immediately after the page load. Thus keeping less memory permanently tied up for the duration of the user's login session. These savings are especially significant in the Dataverse page. + +## Major Use Cases + +Newly-supported use cases in this release include: + +- As a user, I can launch and utilize external tools that allow me to work across the code, data, and other files in a dataset. +- As a user, I can add a footer to my dataverse to show the logo for a funder or other entity. +- As a developer, I can build external tools to verify reproducibility or allow computation. +- As a developer, I can check to see the impact of my proposed changes on memory utilization. +- As an installation administrator, I can make a quick configuration change to provide a better experience for my installation's users. + +## Notes for Dataverse Installation Administrators + +### Configurable User Session Timeout + +Idle session timeout for logged-in users has been made configurable in this release. +The default is now set to 8 hours (this is a change from the previous default value of 24 hours). +If you want to change it, set the setting :LoginSessionTimeout to the new value *in minutes*. +For example, to reduce the timeout to 4 hours: + + curl -X PUT -d 240 http://localhost:8080/api/admin/settings/:LoginSessionTimeout + +Once again, this is the session timeout for *logged-in* users only. For the anonymous sessions the sessions are set to time out after the default ``session-timeout`` value (also in minutes) in the web.xml of the Dataverse application, which is set to 10 minutes. You will most likely not ever need to change this, but if you do, configure it by editing the web.xml file. + +### Flexible Solr Schema, optionally reconfigure Solr + +With this release, we moved all fields in Solr search index that relate to the default metadata schemas from `schema.xml` to separate files. Custom metadata block configuration of the search index can be more easily automated that way. For details, see admin/metadatacustomization.html#updating-the-solr-schema. + +This is optional, but all future changes will go to these files. It might be a good idea to reconfigure Solr now or be aware to look for changes to these files in the future, too. Here's how: + +1. You will need to replace or modify your `schema.xml` with the recent one (containing XML includes) +2. Copy `schema_dv_mdb_fields.xml` and `schema_dv_mdb_copies.xml` to the same location as the `schema.xml` +3. A re-index is not necessary as long no other changes happened, as this is only a reorganization of Solr fields from a single schema.xml file into multiple files. + +In case you use custom metadata blocks, you might find the new `updateSchemaMDB.sh` script beneficial. Again, +see http://guides.dataverse.org/en/4.17/admin/metadatacustomization.html#updating-the-solr-schema + +### Memory Benchmark Test + +Developers and installation administrators can take advantage of new scripts to produce graphs of memory usage and garbage collection events. This is helpful for developers to investigate the implications of changes on memory usage and it is helpful for installation administrators to compare graphs across releases or time periods. For details see the `scripts/tests/ec2-memory-benchmark` directory. + +### New Database Settings + +[:LoginSessionTimeout](http://guides.dataverse.org/en/4.17/installation/config.html#loginsessiontimeout) controls the session timeout (in minutes) for logged-in users. + +## Notes for Tool Developers and Integrators + +### New Features and Breaking Changes for External Tool Developers + +The good news is that external tools can now be defined at the dataset level and there is new and improved documentation for external tool developers, linked below. + +Additionally, the reserved words `{datasetPid}`, `{{filePid}`, and `{localeCode}` were added. Please consider making it possible to translate your tool into various languages! The reserved word `{datasetVersion}` has been made more flexible. + +The bad news is that there are two breaking changes. First, tools must now define a "scope" of either "file" or "dataset" for the manifest to be successfully loaded into Dataverse. Existing tools in a Dataverse installations will be assigned a scope of "file" automatically by a SQL migration script but new installations of Dataverse will need to load an updated manifest file with this new "scope" variable. + +Second, file level tools that did not previously define a "contentType" are now required to do so. In previously releases, file level tools that did not define a contentType were automatically given a contentType of "text/tab-separated-values" but now Dataverse will refuse to load the manifest file if contentType is not specified. + +The Dataverse team has been reaching out to tool makers about these breaking changes and getting various tools working in the https://github.com/IQSS/dataverse-ansible repo. Thank you for your patience as the dust settles around the external tool framework. + +For more information, check out new Building External Tools section of the API Guide. + +## Complete List of Changes + +For the complete list of code changes in this release, see the 4.17 milestone in Github. + +For help with upgrading, installing, or general questions please post to the Dataverse Google Group or email support@dataverse.org. + +## Installation + +If this is a new installation, please see our Installation Guide. + +## Upgrade + +1. Undeploy the previous version. + +- <glassfish install path>/glassfish4/bin/asadmin list-applications +- <glassfish install path>/glassfish4/bin/asadmin undeploy dataverse + +2. Stop glassfish and remove the generated directory, start + +- service glassfish stop +- remove the generated directory: rm -rf <glassfish install path>glassfish4/glassfish/domains/domain1/generated +- service glassfish start + +3. Deploy this version. + +- <glassfish install path>/glassfish4/bin/asadmin deploy <path>dataverse-4.17.war + +4. Restart glassfish + +5. Update Citation Metadata Block + +- `wget https://github.com/IQSS/dataverse/releases/download/v4.17/citation.tsv` +- `curl http://localhost:8080/api/admin/datasetfield/load -X POST --data-binary @citation.tsv -H "Content-type: text/tab-separated-values"` + From eb21955f990aeedc1d4fc2d91b6108dbb59fb8b0 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Fri, 18 Oct 2019 13:36:13 -0400 Subject: [PATCH 02/16] the actual commit that stubs out the inital doc --- doc/release-notes/4.18-release-notes.md | 73 +++++-------------------- 1 file changed, 13 insertions(+), 60 deletions(-) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index 33ee3e1b758..6cf125cadce 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -1,88 +1,47 @@ -# Dataverse 4.17 +# Dataverse 4.18 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 -### Dataset Level Explore Tools +### Previewers -Tools that integrate with Dataverse can now be launched from the dataset page! This makes it possible to develop and add tools that work across the entire dataset instead of single files. Tools to verify reproducibility and allow researchers to compute on an entire dataset will take advantage of this new infrastructure. - -### Performance Enhancements - -Dataverse now allows installation administrators to configure the session timeout for logged in users using the new `:LoginSessionTimeout` setting. (Session length for anonymous users has been reduced from 24 hours to 10 minutes.) Setting this lower will release system resources as configured and will result in better performance (less memory use) throughout a Dataverse installation. - -Dataverse and Dataset pages have also been optimized to discard more of the objects they allocate immediately after the page load. Thus keeping less memory permanently tied up for the duration of the user's login session. These savings are especially significant in the Dataverse page. +xxx ## Major Use Cases Newly-supported use cases in this release include: -- As a user, I can launch and utilize external tools that allow me to work across the code, data, and other files in a dataset. -- As a user, I can add a footer to my dataverse to show the logo for a funder or other entity. -- As a developer, I can build external tools to verify reproducibility or allow computation. -- As a developer, I can check to see the impact of my proposed changes on memory utilization. -- As an installation administrator, I can make a quick configuration change to provide a better experience for my installation's users. +- Preview +- API Token mgmt ## Notes for Dataverse Installation Administrators -### Configurable User Session Timeout - -Idle session timeout for logged-in users has been made configurable in this release. -The default is now set to 8 hours (this is a change from the previous default value of 24 hours). -If you want to change it, set the setting :LoginSessionTimeout to the new value *in minutes*. -For example, to reduce the timeout to 4 hours: - - curl -X PUT -d 240 http://localhost:8080/api/admin/settings/:LoginSessionTimeout - -Once again, this is the session timeout for *logged-in* users only. For the anonymous sessions the sessions are set to time out after the default ``session-timeout`` value (also in minutes) in the web.xml of the Dataverse application, which is set to 10 minutes. You will most likely not ever need to change this, but if you do, configure it by editing the web.xml file. - -### Flexible Solr Schema, optionally reconfigure Solr - -With this release, we moved all fields in Solr search index that relate to the default metadata schemas from `schema.xml` to separate files. Custom metadata block configuration of the search index can be more easily automated that way. For details, see admin/metadatacustomization.html#updating-the-solr-schema. - -This is optional, but all future changes will go to these files. It might be a good idea to reconfigure Solr now or be aware to look for changes to these files in the future, too. Here's how: +### API Token Mgmt -1. You will need to replace or modify your `schema.xml` with the recent one (containing XML includes) -2. Copy `schema_dv_mdb_fields.xml` and `schema_dv_mdb_copies.xml` to the same location as the `schema.xml` -3. A re-index is not necessary as long no other changes happened, as this is only a reorganization of Solr fields from a single schema.xml file into multiple files. - -In case you use custom metadata blocks, you might find the new `updateSchemaMDB.sh` script beneficial. Again, -see http://guides.dataverse.org/en/4.17/admin/metadatacustomization.html#updating-the-solr-schema - -### Memory Benchmark Test - -Developers and installation administrators can take advantage of new scripts to produce graphs of memory usage and garbage collection events. This is helpful for developers to investigate the implications of changes on memory usage and it is helpful for installation administrators to compare graphs across releases or time periods. For details see the `scripts/tests/ec2-memory-benchmark` directory. +xxx ### New Database Settings -[:LoginSessionTimeout](http://guides.dataverse.org/en/4.17/installation/config.html#loginsessiontimeout) controls the session timeout (in minutes) for logged-in users. +xxx ex. [:LoginSessionTimeout](http://guides.dataverse.org/en/4.17/installation/config.html#loginsessiontimeout) controls the session timeout (in minutes) for logged-in users. ## Notes for Tool Developers and Integrators ### New Features and Breaking Changes for External Tool Developers -The good news is that external tools can now be defined at the dataset level and there is new and improved documentation for external tool developers, linked below. - -Additionally, the reserved words `{datasetPid}`, `{{filePid}`, and `{localeCode}` were added. Please consider making it possible to translate your tool into various languages! The reserved word `{datasetVersion}` has been made more flexible. - -The bad news is that there are two breaking changes. First, tools must now define a "scope" of either "file" or "dataset" for the manifest to be successfully loaded into Dataverse. Existing tools in a Dataverse installations will be assigned a scope of "file" automatically by a SQL migration script but new installations of Dataverse will need to load an updated manifest file with this new "scope" variable. - -Second, file level tools that did not previously define a "contentType" are now required to do so. In previously releases, file level tools that did not define a contentType were automatically given a contentType of "text/tab-separated-values" but now Dataverse will refuse to load the manifest file if contentType is not specified. - -The Dataverse team has been reaching out to tool makers about these breaking changes and getting various tools working in the https://github.com/IQSS/dataverse-ansible repo. Thank you for your patience as the dust settles around the external tool framework. +Previews.... For more information, check out new Building External Tools section of the API Guide. ## Complete List of Changes -For the complete list of code changes in this release, see the 4.17 milestone in Github. +For the complete list of code changes in this release, see the 4.18 milestone in Github. For help with upgrading, installing, or general questions please post to the Dataverse Google Group or email support@dataverse.org. ## Installation -If this is a new installation, please see our Installation Guide. +If this is a new installation, please see our Installation Guide. ## Upgrade @@ -99,12 +58,6 @@ If this is a new installation, please see our Date: Tue, 22 Oct 2019 21:59:12 -0400 Subject: [PATCH 03/16] adding in some notes, more to come --- doc/release-notes/4.18-release-notes.md | 33 +++++++++++++++++++------ 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index 6cf125cadce..48f6fa82b05 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -4,16 +4,33 @@ This release brings new features, enhancements, and bug fixes to Dataverse. Than ## Release Highlights -### Previewers +### File Page Previews and Previewers -xxx +File-level External Tools can now be configured to display in a "Preview Mode" designed for embedding within a file page. + +While not technically part of this release, previewers have been made available for several common file types. The previewers support for spreadsheet, image, text, document, audio, video, html files and more. These previewers can be found in the Qualitative Data Repository Github Repository. + +### Primefaces 7 + +Primefaces, the open source UI framework upon which the Dataverse front end is built, has been updated to the most recent version. This provides security updates and bug fixes and will also allow Dataverse developers to take advantage of new features and enhancements. + +### Integration Test Pipeline and Health Reporting + +As part of the Dataverse Community's ongoing efforts to provide more robust automated testing infrastructure, and in support of the project's desire to have the develop branch constantly in a "release ready" state, API-based integration tests are now run every time a branch is merged to develop. The status of the last test run is available as a badge at the bottom of the readme.md file that serves as the homepage of Dataverse Github Repository. + +### Make Data Count Metrics Updates + +A new configuration option has been added that allows Make Data Count metrics to be collected, but not reflected in the front end. This option was designed to allow installations to collect and verify metrics for a period before turning on the display to users. ## Major Use Cases Newly-supported use cases in this release include: -- Preview -- API Token mgmt +- Users can view previews of several common file types, eliminating the need to download a file just to get a quick look. +- Dataverse administrators can now revoke and regenerate API tokens with an API call. +- Users will receive notifications when their ingests complete, and will be informed if the ingest was a success or failure. +- Dataverse developers will receive feedback about the health of the develop branch after their pull request was merged +- Dataverse administrators will be able to collect Make Data Count metrics without turning on the display for users ## Notes for Dataverse Installation Administrators @@ -23,15 +40,17 @@ xxx ### New Database Settings -xxx ex. [:LoginSessionTimeout](http://guides.dataverse.org/en/4.17/installation/config.html#loginsessiontimeout) controls the session timeout (in minutes) for logged-in users. +MDC URLs +MDC Metrics without display + + ex. [:LoginSessionTimeout](http://guides.dataverse.org/en/4.17/installation/config.html#loginsessiontimeout) controls the session timeout (in minutes) for logged-in users. ## Notes for Tool Developers and Integrators ### New Features and Breaking Changes for External Tool Developers Previews.... - -For more information, check out new Building External Tools section of the API Guide. +API Token Management... ## Complete List of Changes From e43d3938f652fb29eaeb25e30ef4505d3c694bc4 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Tue, 22 Oct 2019 22:15:50 -0400 Subject: [PATCH 04/16] a little more content, still some more to go --- doc/release-notes/4.18-release-notes.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index 48f6fa82b05..7d246fc3285 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -29,28 +29,34 @@ Newly-supported use cases in this release include: - Users can view previews of several common file types, eliminating the need to download a file just to get a quick look. - Dataverse administrators can now revoke and regenerate API tokens with an API call. - Users will receive notifications when their ingests complete, and will be informed if the ingest was a success or failure. -- Dataverse developers will receive feedback about the health of the develop branch after their pull request was merged -- Dataverse administrators will be able to collect Make Data Count metrics without turning on the display for users +- Dataverse developers will receive feedback about the health of the develop branch after their pull request was merged. +- Dataverse administrators will be able to collect Make Data Count metrics without turning on the display for users. ## Notes for Dataverse Installation Administrators ### API Token Mgmt -xxx +//Need to refresh my memory here + +### New JVM Options + +[:mdcbaseurlstring](http://guides.dataverse.org/en/4.18/installation/config.html#mdcbaseurlstring) allows dataverse administrators to use a test base URL for Make Data Count ### New Database Settings -MDC URLs -MDC Metrics without display +[:MDCLogPath](http://guides.dataverse.org/en/4.18/installation/config.html#MDCLogPath) sets the path where the raw Make Data Count logs are stored before being processed. - ex. [:LoginSessionTimeout](http://guides.dataverse.org/en/4.17/installation/config.html#loginsessiontimeout) controls the session timeout (in minutes) for logged-in users. +[:DisplayMDCMetrics](http://guides.dataverse.org/en/4.18/installation/config.html#DisplayMDCMetrics) can be set to false to disable display of MDC metrics. ## Notes for Tool Developers and Integrators -### New Features and Breaking Changes for External Tool Developers +### Preview Mode + +//TBD once preview gets done. + +### API Token Management -Previews.... -API Token Management... +//TBD, need a few more details. ## Complete List of Changes From e3ba074ce7fd3ae116b8280ffaebdc218433f83b Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Thu, 24 Oct 2019 11:09:31 -0400 Subject: [PATCH 05/16] adding blurb from mheppler --- doc/release-notes/4.18-release-notes.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index 7d246fc3285..a078b4f3d29 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -14,6 +14,10 @@ While not technically part of this release, previewers have been made available Primefaces, the open source UI framework upon which the Dataverse front end is built, has been updated to the most recent version. This provides security updates and bug fixes and will also allow Dataverse developers to take advantage of new features and enhancements. +### Add Data and Host Dataverse + +More workflows to Add Data have been added across the UI, including a new button on the My Data tab of the Account page, as well as a link in the Dataverse navbar, which will display on every page. This will provider users much easier access to start depositing data. By default, the Host Dataverse will be the installation root dataverse for these new Add Data workflows, but there is now a dropdown component allowing creators to select a dataverse you have proper permissions to create a new dataverse or dataset in. + ### Integration Test Pipeline and Health Reporting As part of the Dataverse Community's ongoing efforts to provide more robust automated testing infrastructure, and in support of the project's desire to have the develop branch constantly in a "release ready" state, API-based integration tests are now run every time a branch is merged to develop. The status of the last test run is available as a badge at the bottom of the readme.md file that serves as the homepage of Dataverse Github Repository. From 3b8c2f581c9a9d76943189a3356112ac79bb6c66 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Tue, 29 Oct 2019 14:17:49 -0400 Subject: [PATCH 06/16] adding ms login stub --- doc/release-notes/4.18-release-notes.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index a078b4f3d29..a534faa690e 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -26,6 +26,10 @@ As part of the Dataverse Community's ongoing efforts to provide more robust auto A new configuration option has been added that allows Make Data Count metrics to be collected, but not reflected in the front end. This option was designed to allow installations to collect and verify metrics for a period before turning on the display to users. +### MS Login + +... consider moving this up + ## Major Use Cases Newly-supported use cases in this release include: From 1c10862be826c2c03a37f3772171c6bb4423c820 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Wed, 30 Oct 2019 22:44:39 -0400 Subject: [PATCH 07/16] Update 4.18-release-notes.md --- doc/release-notes/4.18-release-notes.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index a534faa690e..b6b5974dbc6 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -10,6 +10,10 @@ File-level External Tools can now be configured to display in a "Preview Mode" d While not technically part of this release, previewers have been made available for several common file types. The previewers support for spreadsheet, image, text, document, audio, video, html files and more. These previewers can be found in the Qualitative Data Repository Github Repository. +### Microsoft Login + +Users can now create Dataverse accounts and login using self-provisioned Microsoft accounts such as live.com and outlook.com. Users can also use Microsoft accounts managed by their institutions. This new feature not only makes it easier to log in to Dataverse but will also streamline the interaction between any external tools that utilize Azure services that require login. + ### Primefaces 7 Primefaces, the open source UI framework upon which the Dataverse front end is built, has been updated to the most recent version. This provides security updates and bug fixes and will also allow Dataverse developers to take advantage of new features and enhancements. @@ -26,15 +30,12 @@ As part of the Dataverse Community's ongoing efforts to provide more robust auto A new configuration option has been added that allows Make Data Count metrics to be collected, but not reflected in the front end. This option was designed to allow installations to collect and verify metrics for a period before turning on the display to users. -### MS Login - -... consider moving this up - ## Major Use Cases Newly-supported use cases in this release include: - Users can view previews of several common file types, eliminating the need to download a file just to get a quick look. +- Users can log in using self-provisioned Microsoft accounts and also can log in using Microsoft accounts managed by an organization. - Dataverse administrators can now revoke and regenerate API tokens with an API call. - Users will receive notifications when their ingests complete, and will be informed if the ingest was a success or failure. - Dataverse developers will receive feedback about the health of the develop branch after their pull request was merged. @@ -42,7 +43,7 @@ Newly-supported use cases in this release include: ## Notes for Dataverse Installation Administrators -### API Token Mgmt +### API Token Management //Need to refresh my memory here From 1e411214e7a713d1dc64ac57efaf1fd854cdfb57 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Mon, 4 Nov 2019 10:05:15 -0500 Subject: [PATCH 08/16] stubs for new things merged for 4.18 --- doc/release-notes/4.18-release-notes.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index b6b5974dbc6..5d4622dcf76 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -30,6 +30,10 @@ As part of the Dataverse Community's ongoing efforts to provide more robust auto A new configuration option has been added that allows Make Data Count metrics to be collected, but not reflected in the front end. This option was designed to allow installations to collect and verify metrics for a period before turning on the display to users. +### Search API Enhancements + +Unpublished data... + ## Major Use Cases Newly-supported use cases in this release include: @@ -67,6 +71,10 @@ Newly-supported use cases in this release include: //TBD, need a few more details. +### View Unpublished Data Using Search API + +//TBD + ## Complete List of Changes For the complete list of code changes in this release, see the 4.18 milestone in Github. From cf3d5afbc42dc738cfd8b684ed8c819d2f1c6550 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Mon, 4 Nov 2019 19:27:30 -0500 Subject: [PATCH 09/16] A few more edits, filling in some stubs --- doc/release-notes/4.18-release-notes.md | 26 ++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index 5d4622dcf76..a568df42c47 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -6,23 +6,22 @@ This release brings new features, enhancements, and bug fixes to Dataverse. Than ### File Page Previews and Previewers -File-level External Tools can now be configured to display in a "Preview Mode" designed for embedding within a file page. +File-level External Tools can now be configured to display in a "Preview Mode" designed for embedding within the file landing page. While not technically part of this release, previewers have been made available for several common file types. The previewers support for spreadsheet, image, text, document, audio, video, html files and more. These previewers can be found in the Qualitative Data Repository Github Repository. ### Microsoft Login -Users can now create Dataverse accounts and login using self-provisioned Microsoft accounts such as live.com and outlook.com. Users can also use Microsoft accounts managed by their institutions. This new feature not only makes it easier to log in to Dataverse but will also streamline the interaction between any external tools that utilize Azure services that require login. - -### Primefaces 7 - -Primefaces, the open source UI framework upon which the Dataverse front end is built, has been updated to the most recent version. This provides security updates and bug fixes and will also allow Dataverse developers to take advantage of new features and enhancements. +Users can now create Dataverse accounts and login using self-provisioned Microsoft accounts such as live.com and outlook.com. Users can also use Microsoft accounts managed by their institutions. This new feature not only makes it easier to log in to Dataverse but will also streamline the interaction between any external tools that utilize Azure services that require login. ### Add Data and Host Dataverse More workflows to Add Data have been added across the UI, including a new button on the My Data tab of the Account page, as well as a link in the Dataverse navbar, which will display on every page. This will provider users much easier access to start depositing data. By default, the Host Dataverse will be the installation root dataverse for these new Add Data workflows, but there is now a dropdown component allowing creators to select a dataverse you have proper permissions to create a new dataverse or dataset in. +### Primefaces 7 + +Primefaces, the open source UI framework upon which the Dataverse front end is built, has been updated to the most recent version. This provides security updates and bug fixes and will also allow Dataverse developers to take advantage of new features and enhancements. -### Integration Test Pipeline and Health Reporting +### Integration Test Pipeline and Test Health Reporting As part of the Dataverse Community's ongoing efforts to provide more robust automated testing infrastructure, and in support of the project's desire to have the develop branch constantly in a "release ready" state, API-based integration tests are now run every time a branch is merged to develop. The status of the last test run is available as a badge at the bottom of the readme.md file that serves as the homepage of Dataverse Github Repository. @@ -32,24 +31,25 @@ A new configuration option has been added that allows Make Data Count metrics to ### Search API Enhancements -Unpublished data... +The Dataverse Search API will now display unpublished content when an API token is passed (and appropriate permissions exist). ## Major Use Cases Newly-supported use cases in this release include: -- Users can view previews of several common file types, eliminating the need to download a file just to get a quick look. +- Users can view previews of several common file types, eliminating the need to download or explore a file just to get a quick look. - Users can log in using self-provisioned Microsoft accounts and also can log in using Microsoft accounts managed by an organization. - Dataverse administrators can now revoke and regenerate API tokens with an API call. - Users will receive notifications when their ingests complete, and will be informed if the ingest was a success or failure. - Dataverse developers will receive feedback about the health of the develop branch after their pull request was merged. +- Dataverse tool developers will be able to query the Dataverse API for unpublished data as well as published data. - Dataverse administrators will be able to collect Make Data Count metrics without turning on the display for users. ## Notes for Dataverse Installation Administrators ### API Token Management -//Need to refresh my memory here +- You can now delete a user's API token, recreate a user's API token, and find a token's expiration date. See the Native API guide for more information. ### New JVM Options @@ -65,15 +65,15 @@ Newly-supported use cases in this release include: ### Preview Mode -//TBD once preview gets done. +Tool Developers can now add the `hasPreviewMode` parameter to their file level external tools, which provides an embedded, simplified view of the tool on the file pages for any installation that installs the tool. See Building External Tools for more information. ### API Token Management -//TBD, need a few more details. +If your tool writes content back to Dataverse, you can now take advantage of administrative endpoints that delete and re-create API tokens. You can also use an endpoint that provides the expiration date of a specific API token. See the Native API guide for more information. ### View Unpublished Data Using Search API -//TBD +If you pass a token, the search API output will include unpublished content. ## Complete List of Changes From c0eb054c75b73b7435038d9397d9ebe53ecee463 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Tue, 5 Nov 2019 12:59:13 -0500 Subject: [PATCH 10/16] capitalize README to match actual file --- doc/release-notes/4.18-release-notes.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index a568df42c47..23d4635c9b7 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -23,7 +23,7 @@ Primefaces, the open source UI framework upon which the Dataverse front end is b ### Integration Test Pipeline and Test Health Reporting -As part of the Dataverse Community's ongoing efforts to provide more robust automated testing infrastructure, and in support of the project's desire to have the develop branch constantly in a "release ready" state, API-based integration tests are now run every time a branch is merged to develop. The status of the last test run is available as a badge at the bottom of the readme.md file that serves as the homepage of Dataverse Github Repository. +As part of the Dataverse Community's ongoing efforts to provide more robust automated testing infrastructure, and in support of the project's desire to have the develop branch constantly in a "release ready" state, API-based integration tests are now run every time a branch is merged to develop. The status of the last test run is available as a badge at the bottom of the README.md file that serves as the homepage of Dataverse Github Repository. ### Make Data Count Metrics Updates @@ -102,4 +102,4 @@ If this is a new installation, please see our Date: Wed, 6 Nov 2019 18:04:42 -0500 Subject: [PATCH 11/16] removing mdc log path which was released in 4.17 --- doc/release-notes/4.18-release-notes.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index 23d4635c9b7..f4e7fb230ba 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -57,8 +57,6 @@ Newly-supported use cases in this release include: ### New Database Settings -[:MDCLogPath](http://guides.dataverse.org/en/4.18/installation/config.html#MDCLogPath) sets the path where the raw Make Data Count logs are stored before being processed. - [:DisplayMDCMetrics](http://guides.dataverse.org/en/4.18/installation/config.html#DisplayMDCMetrics) can be set to false to disable display of MDC metrics. ## Notes for Tool Developers and Integrators From 79113db935e74f29cf3bb34fe45f9545ab0fbcdb Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Wed, 6 Nov 2019 18:10:10 -0500 Subject: [PATCH 12/16] one more space --- doc/release-notes/4.18-release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index f4e7fb230ba..531544c26d4 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -71,7 +71,7 @@ If your tool writes content back to Dataverse, you can now take advantage of adm ### View Unpublished Data Using Search API -If you pass a token, the search API output will include unpublished content. +If you pass a token, the search API output will include unpublished content. ## Complete List of Changes From ba6cad9d994bd8c40e9dea897df08668e13b05da Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Fri, 8 Nov 2019 00:27:10 -0500 Subject: [PATCH 13/16] final changes before code review --- doc/release-notes/4.18-release-notes.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index 531544c26d4..880548289eb 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -17,6 +17,7 @@ Users can now create Dataverse accounts and login using self-provisioned Microso ### Add Data and Host Dataverse More workflows to Add Data have been added across the UI, including a new button on the My Data tab of the Account page, as well as a link in the Dataverse navbar, which will display on every page. This will provider users much easier access to start depositing data. By default, the Host Dataverse will be the installation root dataverse for these new Add Data workflows, but there is now a dropdown component allowing creators to select a dataverse you have proper permissions to create a new dataverse or dataset in. + ### Primefaces 7 Primefaces, the open source UI framework upon which the Dataverse front end is built, has been updated to the most recent version. This provides security updates and bug fixes and will also allow Dataverse developers to take advantage of new features and enhancements. @@ -53,7 +54,7 @@ Newly-supported use cases in this release include: ### New JVM Options -[:mdcbaseurlstring](http://guides.dataverse.org/en/4.18/installation/config.html#mdcbaseurlstring) allows dataverse administrators to use a test base URL for Make Data Count +[:mdcbaseurlstring](http://guides.dataverse.org/en/4.18/installation/config.html#mdcbaseurlstring) allows dataverse administrators to use a test base URL for Make Data Count. ### New Database Settings @@ -63,7 +64,7 @@ Newly-supported use cases in this release include: ### Preview Mode -Tool Developers can now add the `hasPreviewMode` parameter to their file level external tools, which provides an embedded, simplified view of the tool on the file pages for any installation that installs the tool. See Building External Tools for more information. +Tool Developers can now add the `hasPreviewMode` parameter to their file level external tools. This setting provides an embedded, simplified view of the tool on the file pages for any installation that installs the tool. See Building External Tools for more information. ### API Token Management From eec88b96a70c64b99b0cec0dde0e4d3ed3b93501 Mon Sep 17 00:00:00 2001 From: Michael Heppler Date: Fri, 8 Nov 2019 12:35:16 -0500 Subject: [PATCH 14/16] Minor grammatical edits [ref #6297] --- doc/release-notes/4.18-release-notes.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index 880548289eb..b5a9712e331 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -16,7 +16,7 @@ Users can now create Dataverse accounts and login using self-provisioned Microso ### Add Data and Host Dataverse -More workflows to Add Data have been added across the UI, including a new button on the My Data tab of the Account page, as well as a link in the Dataverse navbar, which will display on every page. This will provider users much easier access to start depositing data. By default, the Host Dataverse will be the installation root dataverse for these new Add Data workflows, but there is now a dropdown component allowing creators to select a dataverse you have proper permissions to create a new dataverse or dataset in. +More workflows to add data have been added across the UI, including a new button on the My Data tab of the Account page, as well as a link in the Dataverse navbar, which will display on every page. This will provider users much easier access to start depositing data. By default, the Host Dataverse will be the installation root dataverse for these new Add Data workflows, but there is now a dropdown component allowing creators to select a dataverse you have proper permissions to create a new dataverse or dataset in. ### Primefaces 7 @@ -82,7 +82,7 @@ For help with upgrading, installing, or general questions please post to the Installation Guide. +If this is a new installation, please see our Installation Guide. ## Upgrade @@ -91,7 +91,7 @@ If this is a new installation, please see our Date: Tue, 12 Nov 2019 13:39:06 -0500 Subject: [PATCH 15/16] mention new author identifiers #1375 #3169 --- doc/release-notes/4.18-release-notes.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index b5a9712e331..c6f1764557d 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -34,6 +34,14 @@ A new configuration option has been added that allows Make Data Count metrics to The Dataverse Search API will now display unpublished content when an API token is passed (and appropriate permissions exist). +### Additional Dataset Author Identifiers + +The following dataset author identifiers are now supported: + +- DAI: https://en.wikipedia.org/wiki/Digital_Author_Identifier +- ResearcherID: http://researcherid.com +- ScopusID: https://www.scopus.com + ## Major Use Cases Newly-supported use cases in this release include: @@ -45,6 +53,7 @@ Newly-supported use cases in this release include: - Dataverse developers will receive feedback about the health of the develop branch after their pull request was merged. - Dataverse tool developers will be able to query the Dataverse API for unpublished data as well as published data. - Dataverse administrators will be able to collect Make Data Count metrics without turning on the display for users. +- Users with a DAI, ResearcherID, or ScopusID and use these author identifiers in their datasets. ## Notes for Dataverse Installation Administrators @@ -102,3 +111,8 @@ If this is a new installation, please see our Date: Tue, 12 Nov 2019 13:42:43 -0500 Subject: [PATCH 16/16] fix broken links #6287 --- doc/release-notes/4.18-release-notes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/release-notes/4.18-release-notes.md b/doc/release-notes/4.18-release-notes.md index c6f1764557d..56ca67a7983 100644 --- a/doc/release-notes/4.18-release-notes.md +++ b/doc/release-notes/4.18-release-notes.md @@ -59,7 +59,7 @@ Newly-supported use cases in this release include: ### API Token Management -- You can now delete a user's API token, recreate a user's API token, and find a token's expiration date. See the Native API guide for more information. +- You can now delete a user's API token, recreate a user's API token, and find a token's expiration date. See the Native API guide for more information. ### New JVM Options @@ -73,11 +73,11 @@ Newly-supported use cases in this release include: ### Preview Mode -Tool Developers can now add the `hasPreviewMode` parameter to their file level external tools. This setting provides an embedded, simplified view of the tool on the file pages for any installation that installs the tool. See Building External Tools for more information. +Tool Developers can now add the `hasPreviewMode` parameter to their file level external tools. This setting provides an embedded, simplified view of the tool on the file pages for any installation that installs the tool. See Building External Tools for more information. ### API Token Management -If your tool writes content back to Dataverse, you can now take advantage of administrative endpoints that delete and re-create API tokens. You can also use an endpoint that provides the expiration date of a specific API token. See the Native API guide for more information. +If your tool writes content back to Dataverse, you can now take advantage of administrative endpoints that delete and re-create API tokens. You can also use an endpoint that provides the expiration date of a specific API token. See the Native API guide for more information. ### View Unpublished Data Using Search API