From 96c805f4c54231e594168c246a731857ae5551fd Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Mon, 30 Sep 2019 20:06:26 -0400 Subject: [PATCH 1/6] typo update --- scripts/tests/ec2-memory-benchmark/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/tests/ec2-memory-benchmark/README.md b/scripts/tests/ec2-memory-benchmark/README.md index 170495a42e6..4d9a61cbeb0 100644 --- a/scripts/tests/ec2-memory-benchmark/README.md +++ b/scripts/tests/ec2-memory-benchmark/README.md @@ -26,7 +26,7 @@ using the approach tested in #6035 (bombarding the system with GETs on select pages, then taking snapshots of the allocated classes on the heap and the garbage collection stats; see the issue for more info). -In the curret implementation we are testing the two most used pages - +In the current implementation we are testing the two most used pages - dataverse and dataset. Once (and if) it completes, the script will provide links to the produced output (downloadable from the EC2 instance). From 76cc44f9604e2ec129344240d25604e9ab8a0195 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Mon, 30 Sep 2019 20:14:23 -0400 Subject: [PATCH 2/6] adding memory benchmark info --- doc/release-notes/4.17-release-notes.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/release-notes/4.17-release-notes.md b/doc/release-notes/4.17-release-notes.md index 90a7d054427..e3c1b7aa780 100644 --- a/doc/release-notes/4.17-release-notes.md +++ b/doc/release-notes/4.17-release-notes.md @@ -16,8 +16,9 @@ Dataverse now allows installation administrators to configure the session timeou 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 launch and utilize external tools that allow me to work across the code, data, and other files in a dataset. - 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 @@ -46,6 +47,10 @@ This is optional, but all future changes will go to these files. It might be a g 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. @@ -81,6 +86,6 @@ If this is a new installation, please see our Date: Wed, 2 Oct 2019 14:17:56 -0400 Subject: [PATCH 3/6] adding footer --- doc/release-notes/4.17-release-notes.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/release-notes/4.17-release-notes.md b/doc/release-notes/4.17-release-notes.md index e3c1b7aa780..a1b6a492b62 100644 --- a/doc/release-notes/4.17-release-notes.md +++ b/doc/release-notes/4.17-release-notes.md @@ -17,6 +17,7 @@ Dataverse now allows installation administrators to configure the session timeou 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. From 4dca0a337568da46b9de20640c797e5839af350c Mon Sep 17 00:00:00 2001 From: Leonid Andreev Date: Wed, 2 Oct 2019 16:06:34 -0400 Subject: [PATCH 4/6] added the citation block update to the upgarde instructions; added a command line for downloading the tsv file too... just one less exercise for the reader (#6236) --- doc/release-notes/4.17-release-notes.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/release-notes/4.17-release-notes.md b/doc/release-notes/4.17-release-notes.md index a1b6a492b62..fa8c0283399 100644 --- a/doc/release-notes/4.17-release-notes.md +++ b/doc/release-notes/4.17-release-notes.md @@ -90,3 +90,9 @@ If this is a new installation, please see our Date: Wed, 2 Oct 2019 16:23:49 -0400 Subject: [PATCH 5/6] another addition to the release notes (#6236) --- doc/release-notes/4.17-release-notes.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/release-notes/4.17-release-notes.md b/doc/release-notes/4.17-release-notes.md index fa8c0283399..83d420c4dd1 100644 --- a/doc/release-notes/4.17-release-notes.md +++ b/doc/release-notes/4.17-release-notes.md @@ -10,7 +10,9 @@ Tools that integrate with Dataverse can now be launched from the dataset page! T ### 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 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 From ebe8e7d87638e766ede0942e945be559bb1790f4 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Wed, 2 Oct 2019 16:55:52 -0400 Subject: [PATCH 6/6] update release notes for external tools #6236 --- doc/release-notes/4.17-release-notes.md | 16 +++++++++++++--- doc/sphinx-guides/source/api/external-tools.rst | 2 +- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/doc/release-notes/4.17-release-notes.md b/doc/release-notes/4.17-release-notes.md index 83d420c4dd1..33ee3e1b758 100644 --- a/doc/release-notes/4.17-release-notes.md +++ b/doc/release-notes/4.17-release-notes.md @@ -60,9 +60,19 @@ Developers and installation administrators can take advantage of new scripts to ## Notes for Tool Developers and Integrators -### Dataset Level Explore Tools +### 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. -Tool developers can now define the scope of an external tool as file or dataset. This will allow tools to appear for selection at the dataset or file level. For more information, check out the Guides section on External Tools. +For more information, check out new Building External Tools section of the API Guide. ## Complete List of Changes @@ -97,4 +107,4 @@ If this is a new installation, please see our