Conversation
|
|
||
| Update the Citation metadata block: | ||
|
|
||
| - `wget https://github.com/IQSS/dataverse/releases/download/v#.##/citation.tsv` |
There was a problem hiding this comment.
I'm going to go ahead and change this to v5.12
adding the 5.12 version to the tsv download url
pdurbin
left a comment
pdurbin
left a comment
There was a problem hiding this comment.
Overall, this looks great. I made a few comments. Happy to help.
| wdl=text/x-workflow-description-language | ||
| cwl=text/x-computational-workflow-language | ||
| nf=text/x-nextflow | ||
| Rmd=text/x-r-notebook | ||
| rb=text/x-ruby-script | ||
| dag=text/x-dagman |
There was a problem hiding this comment.
These all appear on one line in the HTML version: https://github.com/IQSS/dataverse/blob/04adc496846d9d40162ff49fdd770c9f648f4139/doc/release-notes/5.12-release-notes.md
| rb=text/x-ruby-script | ||
| dag=text/x-dagman | ||
|
|
||
| ### Update to Payara 5.2022.3 highly recommended |
There was a problem hiding this comment.
| ### Update to Payara 5.2022.3 highly recommended | |
| ### Update to Payara 5.2022.3 Highly Recommended |
This applies to other headings as well. Our habit is to Make Them All Sentence Case.
There was a problem hiding this comment.
Made title case throughout (vim shortcut: ~ 😄 ) in da4d835.
|
|
||
| This new facet needs to be configured for it to appear on the search side panel. The configuration assigns to a dataverse what metadata blocks to show. The configuration is inherited by child dataverses. | ||
|
|
||
| To configure the new facet, use the Metadata Block Facet API: <https://guides.dataverse.org/en/latest/api/native-api.html#set-metadata-block-facet-for-a-dataverse-collection> |
There was a problem hiding this comment.
We usually change "latest" to "5.12". That way we can move stuff around in the future. This applies to other cases of "latest" of course.
|
|
||
| # Update to Payara 5.2022.3 highly recommended | ||
|
|
||
| With lots of bug and security fixes included, we encourage everyone to update to Payara 5.2022.3 as soon as possible. |
There was a problem hiding this comment.
This is the same line as above. Not sure if that matters. A little repetitive.
|
|
||
| - Re-export metadata files (OAI_ORE is affected by the PRs in these release notes). Optionally, for those using the Dataverse software's BagIt-based archiving, re-archive dataset versions archived using prior versions of the Dataverse software. This will be recommended/required in a future release. | ||
|
|
||
| - Run ReExportall to update Exports |
There was a problem hiding this comment.
This is very minor, but this last line is kind of redundant. Maybe it could be combined with the one above, like "Run ReExportall to update metadata exports (OAI_ORE is affected ... etc."
There was a problem hiding this comment.
Oh, and if we are mentioning OAI_ORE here, I guess it makes sense to also explicitly mention that the JSON format needs to be re-exported, because of the bug fixed in #8868.
I'll go ahead and make this change.
Small change to the metadata reexport instructions at the end of the release note.
|
I'll be happy to approve the PR once the remaining couple of suggestions from @pdurbin are resolved. Looks good overall. |
- highlight Globus and other big features at top - added missing snippet: New Computational Workflow Metadata Block - fix typos, etc.
|
I just pushed some changes in da4d835. I took a little artistic license and added what I feel are big feature at the top. Specifically, Globus is at the very top now. I did this because "Harvard Data Commons Additions" doesn't really speak to me. What's in there? Who knows? I know we want to give credit to the people who made these features happen but in release notes it makes more sense to me to list the actual features. That's what users of the software care about. I left the "Harvard Data Commons Additions" section intact, of course, and referred to it for details about this or that major feature that I put above it. I'm ok with this getting merged. I'm also ok with people backing out any changes I made. 😄 I hope they are an improvement! Ship it! 🚀 |
4 participants
What this PR does / why we need it:
Which issue(s) this PR closes:
Closes #8979 Create release notes for 5.12
Special notes for your reviewer: Picked up all of the release notes written for issues addressed in this release, also tried to put in notes for issues with no release notes for the list of changes and fixes. Installation instructions are written to include the Payara upgrade even though it could be optional.
Suggestions on how to test this:Test the installation instructions.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Is there a release notes update needed for this change?:
Additional documentation: