Skip to content

Commit

Permalink
replace preview links with 5.14 links #9670
Browse files Browse the repository at this point in the history
  • Loading branch information
pdurbin committed Jul 20, 2023
1 parent 87fd4d2 commit e03ce06
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions doc/release-notes/5.14-release-notes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Dataverse Software 5.14

**TODO: guides preview links need to be changed to point to the permanent `https://guides.dataverse.org/en/5.14/` locations before the release goes live**

(if this note appears truncated on the GitHub Releases page, you can view it in full in the source tree: https://github.com/IQSS/dataverse/blob/master/doc/release-notes/5.14-release-notes.md)

This release brings new features, enhancements, and bug fixes to the Dataverse software. Thank you to all of the community members who contributed code, suggestions, bug reports, and other assistance across the project.
Expand Down Expand Up @@ -153,13 +151,13 @@ See "Handling of license information fixed in the API" for guidance on how to en

### 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)
Developers can experiment with running Dataverse in Docker: https://guides.dataverse.org/en/5.14/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
https://guides.dataverse.org/en/5.14/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
Expand Down Expand Up @@ -205,7 +203,7 @@ Here is a list of the new settings:
- dataverse.pid.ezid.username
- dataverse.pid.ezid.password

See also http://preview.guides.gdcc.io/en/develop/installation/config.html#persistent-identifiers-and-publishing-datasets (multiple PRs: #8823-#8828)
See also https://guides.dataverse.org/en/5.14/installation/config.html#persistent-identifiers-and-publishing-datasets (multiple PRs: #8823-#8828)

### Signposting for Dataverse

Expand Down Expand Up @@ -243,7 +241,7 @@ In order to customize the wording and add translations to the UI sections extend

It is now possible to configure registering PIDs for files in individual collections.

For example, registration of PIDs for files can be enabled in a specific collection when it is disabled instance-wide. Or it can be disabled in specific collections where it is enabled by default. See the [:FilePIDsEnabled](https://guides.dataverse.org/en/latest/installation/config.html#filepidsenabled) section of the Configuration guide for details. (PR #9614)
For example, registration of PIDs for files can be enabled in a specific collection when it is disabled instance-wide. Or it can be disabled in specific collections where it is enabled by default. See the [:FilePIDsEnabled](https://guides.dataverse.org/en/5.14/installation/config.html#filepidsenabled) section of the Configuration guide for details. (PR #9614)

### Mechanism Added for Adding External Exporters

Expand Down Expand Up @@ -286,7 +284,7 @@ Data contained in a dataset may belong to multiple series. Making the field repe

An experimental version of the guides in PDF format is available at <http://preview.guides.gdcc.io/_/downloads/en/develop/pdf/> (PR #9474)

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
Advice for contributors to documentation who want to help improve the PDF is available at https://guides.dataverse.org/en/5.14/developers/documentation.html#pdf-version-of-the-guides

### Datasets API extended

Expand Down Expand Up @@ -343,28 +341,28 @@ And we have corrected the misleading language in the same guide where we used to
jq '.data | del(.files)'
```

Please see the [Update Metadata For a Dataset](https://guides.dataverse.org/en/latest/api/native-api.html#update-metadata-for-a-dataset) section of our Native Api guide for more information.
Please see the [Update Metadata For a Dataset](https://guides.dataverse.org/en/5.14/api/native-api.html#update-metadata-for-a-dataset) section of our Native Api guide for more information.


### Changes and fixes in this release not already mentioned above include:

- An endpoint for deleting a file has been added to the native API: http://preview.guides.gdcc.io/en/develop/api/native-api.html#deleting-files (PR #9383)
- An endpoint for deleting a file has been added to the native API: https://guides.dataverse.org/en/5.14/api/native-api.html#deleting-files (PR #9383)
- A date column has been added to the restricted file access request overview, indicating when the earliest request by that user was made. An issue was fixed where where the request list was not updated when a request was approved or rejected. (PR #9257)
- A feature flag called "api-session-auth" has been added temporarily to aid in the development of the new frontend (#9063) but will be removed once bearer tokens (#9229) have been implemented. There is a security risk (CSRF) in enabling this flag! Do not use it in production! For more information, see http://preview.guides.gdcc.io/en/develop/installation/config.html#feature-flags
- A feature flag called "api-session-auth" has been added temporarily to aid in the development of the new frontend (#9063) but will be removed once bearer tokens (#9229) have been implemented. There is a security risk (CSRF) in enabling this flag! Do not use it in production! For more information, see https://guides.dataverse.org/en/5.14/installation/config.html#feature-flags
- Changes made in v5.13 and v5.14 in multiple PRs to improve the embedded Schema.org metadata in dataset pages will only be propagated to the Schema.Org JSON-LD metadata export if a reExportAll() is done. (PR #9102)
- It is now possible to write external vocabulary scripts that target a single child field in a metadata block. Example scripts are now available at https://github.com/gdcc/dataverse-external-vocab-support that can be configured to support lookup from the Research Orgnaization Registry (ROR) for the Author Affiliation Field and for the CrossRef Funding Registry (Fundreg) in the Funding Information/Agency field, both in the standard Citation metadata block. Application if these scripts to other fields, and the development of other scripts targetting child fields are now possible (PR #9402)
- A feature flag called "api-bearer-auth" has been added. This allows OIDC useraccounts to send authenticated API requests using Bearer Tokens. Note: This feature is limited to OIDC! For more information, see http://preview.guides.gdcc.io/en/develop/installation/config.html#feature-flags (PR #9591)
- A feature flag called "api-bearer-auth" has been added. This allows OIDC useraccounts to send authenticated API requests using Bearer Tokens. Note: This feature is limited to OIDC! For more information, see https://guides.dataverse.org/en/5.14/installation/config.html#feature-flags (PR #9591)
- 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)
- 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)
- 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/5.14/installation/config.html?highlight=updatehashvalues#filefixitychecksumalgorithm) to replace any MD5 hashes on existing files. (PR #9482)
- The OAI_ORE metadata export (and hence the archival Bag for a dataset) now includes information about file embargoes. (PR #9698)
- DatasetFieldType attribute "displayFormat", is now returned by the API. (PR #9668)
- An API named "MyData" is supported by Dataverse. It is used to get a list of the objects (datasets, collections or datafiles) that an authenticated user can modify. Documentation has been added describing its use. (PR #9596)
- A Go client library is now available. See https://preview.guides.gdcc.io/en/develop/api/client-libraries.html
- A Go client library is now available. See https://guides.dataverse.org/en/5.14/api/client-libraries.html


## Complete List of Changes
Expand Down

0 comments on commit e03ce06

Please sign in to comment.