more notes added (#9670)

doc/release-notes/5.14-release-notes.md

@@ -2,6 +2,8 @@
 
 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.
 
+You can jump directly to the Installation and/or Upgrade sections.
+
 ## Release Highlights
 
 ### 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.
@@ -10,6 +12,7 @@ This is enabled via the new setting `:MDCStartDate` that specifies the cutoff da
 
 ### An API endpoint for deleting a file is finally available
 
+**TODO: move under "other fixes"**
 Support for deleting files using native API: http://preview.guides.gdcc.io/en/develop/api/native-api.html#deleting-files (PR #9383)
 
 ### Changes to PID Provider JVM Settings
@@ -95,6 +98,50 @@ Care should be taken when replacing Dataverse's internal metadata export formats
 
 dataverse.spi.export.directory - specifies a directory, readable by the Dataverse server. Any Exporter JAR files placed in this directory will be read by Dataverse and used to add/replace the specified metadata format.
 
+### Contact Email Improvements
+
+Email sent from the contact forms to the contact(s) for a collection, dataset, or datafile can now optionally be cc'd to a support email address. The support email address can be changed from the default :SystemEmail address to a separate :SupportEmail address. When multiple contacts are listed, the system will now send one email to all contacts (with the optional cc if configured) instead of separate emails to each contact. Contact names with a comma that refer to Organizations will no longer have the name parts reversed in the email greeting. A new protected feedback API has been added. (PR #9204)
+
+#### Backward Incompatibilities
+
+**TODO: add to the backward incompatibilities section**
+When there are multiple contacts, the system will now send one email with all of the contacts in the To: header instead of sending one email to each contact (with no indication that others have been notified).
+
+#### New JVM/MicroProfile Settings
+
+dataverse.mail.support-email - allows a separate email, distinct from the :SystemEmail to be used as the to address in emails from the contact form/ feedback api.
+dataverse.mail.cc-support-on-contact-emails - include the support email address as a CC: entry when contact/feedback emails are sent to the contacts for a collection, dataset, or datafile.
+
+### Support for Grouping Dataset Files by Folder and Category Tag
+
+Dataverse now supports grouping dataset files by folder and/or optionally by Tag/Category. The default for whether to order by folder can be changed via :OrderByFolder. Ordering by category must be enabled by an administrator via the :CategoryOrder parameter which is used to specify which tags appear first (e.g. to put Documentation files before Data or Code files, etc.) These Group-By options work with the existing sort options, i.e. sorting alphabetically means that files within each folder or tag group will be sorted alphabetically. :AllowUsersToManageOrdering can be set to true to allow users to turn folder ordering and category ordering (if enabled) on or off in the current dataset view.
+
+#### New Setting
+
+:CategoryOrder - a comma separated list of Category/Tag names defining the order in which files with those tags should be displayed. The setting can include custom tag names along with the pre-defined defaults ( Documentation, Data, and Code, which can be overridden by the ::FileCategories setting.)
+:OrderByFolder - defaults to true - whether to group files in the same folder together
+:AllowUserManagementOfOrder - default false - allow users to toggle ordering on/off in the dataset display
+
+### Metadata field Series now repeatable
+
+This enhancement allows depositors to define multiple instances of the metadata field Series in the Citation Metadata block.
+
+Data contained in a dataset may belong to multiple series. Making the field repeatable makes it possible to reflect this fact in the dataset metadata. (PR #9256)
+
+### Guides in PDF Format
+
+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
+
+### 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)
+
+This should make it easier to write code to reproduce results as the dataset authors and subsequent researchers are likely operating on the original file format rather that the format that Dataverse creates.
+
+For details, see #9374, <https://github.com/jupyterhub/repo2docker/issues/1242>, and <https://github.com/jupyterhub/repo2docker/pull/1253>.
+
 ### Handling of license information fixed in the API
 
 (PR #9568)
@@ -134,6 +181,10 @@ Please see the [Update Metadata For a Dataset](https://guides.dataverse.org/en/l
 - 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)
 - TODO: The 5.14 release notes should include the standard instructions for doing a reExportAll after updating the code, on account of the item above. (L.A.)
 - 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)
+- 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)
 
 ## New JVM Options and MicroProfile Config Options
 
@@ -221,7 +272,7 @@ In the following commands we assume that Payara 5 is installed in `/usr/local/pa
 - `service payara stop`
 - `service payara start`
 
-6\. Reload citation metadata block (**TODO: may not be necessary, and/or another block may need to be updated**)
+6\. Update the Citation metadata block: (the update makes the field Series repeatable)
 
 - `wget https://github.com/IQSS/dataverse/releases/download/v5.14/citation.tsv`
 - `curl http://localhost:8080/api/admin/datasetfield/load -X POST --data-binary @citation.tsv -H "Content-type: text/tab-separated-values"`
@@ -231,7 +282,7 @@ If you are running an English-only installation, you are finished with the citat
 - `wget https://github.com/IQSS/dataverse/releases/download/v5.14/citation.properties`
 - `cp citation.properties /home/dataverse/langBundles`
 
-7\. Replace Solr schema.xml (**TODO: may not be necessary for 5.14) See specific instructions below for those installations without custom metadata blocks (1a) and those with  custom metadata blocks  (1b).
+7\. Replace Solr schema.xml to allow multiple series to be used. See specific instructions below for those installations without custom metadata blocks (1a) and those with  custom metadata blocks  (1b).
 
 Note: with this release support for indexing of the experimental workflow metadata block has been removed from the standard schema.xml. 
 If you are using the workflow metadata block be sure to follow the instructions in step 7b) below to maintain support for indexing workflow metadata.
@@ -250,21 +301,13 @@ If you are using the workflow metadata block be sure to follow the instructions
 
 - Stop solr instance (usually service solr stop, depending on solr installation/OS, see the [Installation Guide](https://guides.dataverse.org/en/5.14/installation/prerequisites.html#solr-init-script)
 
-- Edit the following line to your schema.xml (to indicate that productionPlace is now multiValued='true"):
-
-    `<field name="productionPlace" type="string" stored="true" indexed="true" multiValued="true"/>`
+- Edit the following lines in your schema.xml (to indicate that series and its components are now `multiValued="true"`):
 
-- Add the following lines to your schema.xml to add support for geospatial indexing:
+     `<field name="series" type="string" stored="true" indexed="true" multiValued="true"/>`
+     `<field name="seriesInformation" type="text_en" multiValued="true" stored="true" indexed="true"/>`
+     `<field name="seriesName" type="text_en" multiValued="true" stored="true" indexed="true"/>`
 
-    `<!-- Dataverse geospatial search -->`
-    `<!-- https://solr.apache.org/guide/8_11/spatial-search.html#rpt -->`
-    `<field name="geolocation" type="location_rpt" multiValued="true" stored="true" indexed="true"/>`
-    `<!-- https://solr.apache.org/guide/8_11/spatial-search.html#bboxfield -->`
-    `<field name="boundingBox" type="bbox" multiValued="true" stored="true" indexed="true"/>`
-    `<!-- Dataverse - per GeoBlacklight, adding field type for bboxField that enables, among other things, overlap ratio calculations -->`
-    `<fieldType name="bbox" class="solr.BBoxField"
-           geo="true" distanceUnits="kilometers" numberType="pdouble" />`
-    **TODO: why are we recommending editing the schema file by hand, instead of re-running the update script?**
+     **TODO: why are we recommending editing the schema file by hand, instead of re-running the update script?**
 
 - Restart Solr instance (usually service solr start, depending on solr/OS)