Skip to content

Commit

Permalink
remaining notes added. (#9670)
Browse files Browse the repository at this point in the history
  • Loading branch information
landreev committed Jun 29, 2023
1 parent a57a8ea commit 0ecd7c6
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 33 deletions.
48 changes: 47 additions & 1 deletion doc/release-notes/5.14-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,28 @@ This release brings new features, enhancements, and bug fixes to the Dataverse s

You can jump directly to the Installation and/or Upgrade sections.

## Release Highlights
## Release Highlights, New Features and Use Case Scenarios

### For Dataverse developers, support for running Dataverse in Docker (experimental)

Developers can experiment with running Dataverse in Docker: https://preview.guides.gdcc.io/en/develop/container/app-image.html (PR #9439)

This is an image developers build locally. It is not meant for production use!

To provide a complete container-based local development environment, developers can deploy a Dataverse container from
the new image in addition to other containers for the necessary dependencies:
https://preview.guides.gdcc.io/en/develop/container/dev-usage.html

Please note that with this emerging solution we will sunset older tooling like `docker-aio` and `docker-dcm`.
We envision more testing possibilities in the future, to be discussed as part of the
[Dataverse Containerization Working Group](https://dc.wgs.gdcc.io). There is no roadmap yet, but you have been warned.
If there is some specific feature of these tools you would like to be kept, please [reach out](https://dc.wgs.gdcc.io).

### Indexing performance improved

Noticeable improvements in performance, especially for large datasets containing thousands of files.
Uploading files one by one to the dataset is much faster now, allowing uploading thousands of files in an acceptable timeframe. Not only uploading a file, but all edit operations on datasets containing many files, got faster.
Performance tweaks include indexing of the datasets in the background and optimizations in the amount of the indexing operations needed. Furthermore, updates to the dateset no longer wait for ingesting to finish. Ingesting was already running in the background, but it took a lock, preventing updating the dataset and degrading performance for datasets containing many files. (PR #9558)

### For installations using MDC (Make Data Count), it is now possible to display both the MDC metrics and the legacy access counts, generated before MDC was enabled.

Expand Down Expand Up @@ -134,6 +155,26 @@ An experimental version of the guides in PDF format is available at <http://prev

Advice for contributors to documentation who want to help improve the PDF is available at http://preview.guides.gdcc.io/en/develop/developers/documentation.html#pdf-version-of-the-guides

### Datasets API extended

The following APIs have been added: (PR #9592)

- `/api/datasets/summaryFieldNames`
- `/api/datasets/privateUrlDatasetVersion/{privateUrlToken}`
- `/api/datasets/privateUrlDatasetVersion/{privateUrlToken}/citation`
- `/api/datasets/{datasetId}/versions/{version}/citation`

### Extra fields included in the JSON metadata

The following fields are now available in the native JSON output:

- `alternativePersistentId`
- `publicationDate`
- `citationDate`

(PR #9657)


### Files downloaded from Binder are now in their original format.

For example, data.dta (a Stata file) will be downloaded instead of data.tab (the archival version Dataverse creates as part of a successful ingest). (PR #9483)
Expand Down Expand Up @@ -185,6 +226,11 @@ Please see the [Update Metadata For a Dataset](https://guides.dataverse.org/en/l
- An attempt will be made to extract a geospatial bounding box (west, south, east, north) from NetCDF and HDF5 files and then insert these values into the geospatial metadata block, if enabled. (#9541)
- New alternative to setup the Dataverse dependencies for the development environment through Docker Compose. (PR #9417)
- New alternative, explained in the documentation, to build the Sphinx guides through a Docker container. (PR #9417)
- A container has been added called "configbaker" that configures Dataverse while running in containers. This allows developers to spin up Dataverse with a single command. (PR #9574)
- A file previewer called H5Web is now available for exploring and visualizing NetCDF and HDF5 files. (PR #9600)
- Dataverse now supports requiring a secret key to add or edit metadata in specified 'system' metadata blocks. Changing the metadata in such system metadata blocks is not allowed without the key and is currently only allowed via API. (PR #9388, **TODO: unmerged as of writing this L.A.**)
- Direct upload via the Dataverse UI will now support any algorithm configured via the `:FileFixityChecksumAlgorithm` setting. External apps using the direct upload API can now query Dataverse to discover which algorithm should be used. Sites that have been using an algorithm other than MD5 and direct upload and/or dvwebloader may want to use the `/api/admin/updateHashValues` call (see https://guides.dataverse.org/en/latest/installation/config.html?highlight=updatehashvalues#filefixitychecksumalgorithm) to replace any MD5 hashes on existing files. (PR #9482)


## New JVM Options and MicroProfile Config Options

Expand Down
4 changes: 0 additions & 4 deletions doc/release-notes/9431-checksum-alg-in-direct-uploads.md

This file was deleted.

12 changes: 0 additions & 12 deletions doc/release-notes/9434-app-container.md

This file was deleted.

1 change: 0 additions & 1 deletion doc/release-notes/9480-h5web.md

This file was deleted.

3 changes: 0 additions & 3 deletions doc/release-notes/9558-async-indexing.md

This file was deleted.

1 change: 0 additions & 1 deletion doc/release-notes/9573-configbaker.md

This file was deleted.

6 changes: 0 additions & 6 deletions doc/release-notes/9588-datasets-api-extension.md

This file was deleted.

5 changes: 0 additions & 5 deletions doc/release-notes/9656-api-optional-dataset-params.md

This file was deleted.

0 comments on commit 0ecd7c6

Please sign in to comment.