Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#9332 5.13 release notes #9379

Merged
merged 15 commits into from
Feb 14, 2023
Merged

#9332 5.13 release notes #9379

merged 15 commits into from
Feb 14, 2023

Conversation

sekmiller
Copy link
Contributor

What this PR does / why we need it: Consolidates release notes from all PRs included in the 5.13 release

Which issue(s) this PR closes:

Closes #9332 Write 5.13 release notes

Special notes for your reviewer:
I left release highlights blank for now because I wasn't sure what we should be highlighting.
Also Jim and or Phil please take a look at the schema.xml upgrade instructions for geospatial.

Suggestions on how to test this:
At least go through the upgrade steps

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?:
wouldn't that be ironic?

Additional documentation:

@sekmiller sekmiller added this to Ready for Review ⏩ in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) via automation Feb 10, 2023
@sekmiller sekmiller changed the title #9332 consolidate notes delete individual files #9332 5.13 release notes Feb 10, 2023
@pdurbin pdurbin self-assigned this Feb 10, 2023
@pdurbin pdurbin moved this from Ready for Review ⏩ to Review 🔎 in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) Feb 10, 2023
Note that the "preview" links need to be changed to 5.13
@pdurbin pdurbin removed their assignment Feb 10, 2023
@pdurbin
Copy link
Member

pdurbin commented Feb 10, 2023

In 69a1d7a I did a major rewrite of the release highlights.

We still need to look over the upgrade details.

And I need to switch all the links from http://preview.guides.gdcc.io/en/develop/ to 5.13 (which doesn't exist yet).


### Support for Cleaning up Leftover Files in Dataset Storage

Experimental feature: the leftover files stored in the Dataset storage location that are not in the file list of that Dataset, but are named following the Dataverse technical convetion for dataset files, can be removed with the new [Cleanup Storage of a Dataset](http://preview.guides.gdcc.io/en/develop/api/native-api.html#cleanup-storage-of-a-dataset) API endpoint.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

convetion -> convention

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!


- restart solr instance (usually service solr start, depending on solr/OS)

### Optional Upgrade Step: remove Workflow Schema fields from Solr index
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't this happen in step 7?

removed it from the schema. If you are deploying the block to your installation, make sure to
update your index.

If you already added these fields, you can delete them from your index when not using the schema.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, could somebody please rewrite/clarify this sentence. If I understand it correctly (a big if), the words "delete from your index" in it mean "delete from your Solr schema", and then "when not using the schema" really means "if you are not using this metadata block". It did confuse me, because we usually don't call metadata blocks "schemas", and because we are talking about solr schema in the same paragraph...
I am kinda slow of course... but I can see how it may confuse another admin - ?


7b\.

For installations with Custom Metadata Blocks:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or experimental ones?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I highlighted the change to workflow support in the section on the schema.xml updates. Please take a look to see if you think it's adequate and understandable.

@sekmiller sekmiller self-assigned this Feb 13, 2023
@sekmiller sekmiller removed their assignment Feb 13, 2023

7a\.

For installations without Custom Metadata Blocks:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updates look good to me. Would it be useful to make this "without Custom or Experimental Metadata Blocks" to mirror 7b?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup. will do.

Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@landreev was still assigned but he's done hacking on these release notes. So am I. Approved! Off to QA! Thanks again to @sekmiller for kicking these off and to all others (@qqmyers et al.) for taking a look!

IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from Review 🔎 to Ready for QA ⏩ Feb 13, 2023
@kcondon
Copy link
Contributor

kcondon commented Feb 14, 2023

Need some clarification on this line:
Add the updated citation.properties file to the appropriate directory

This might be what's missing: (https://guides.dataverse.org/en/5.12.1/admin/metadatacustomization.html?highlight=metadata%20block#loading-tsv-files-into-a-dataverse-installation)

If you are improving an existing metadata block, the Dataverse Software installation process will load the TSV for you, assuming you edited the TSV file in place. The TSV file for the Citation metadata block, for example, can be found at scripts/api/data/metadatablocks/citation.tsv. If any of the below mentioned property values are changed, corresponding ResourceBundle property file has to be edited and stored under dataverse.lang.directory location

name, displayName property under #metadataBlock
name, title, description, watermark properties under #datasetfield

DatasetField, Value property under #controlledVocabulary

pdurbin and others added 3 commits February 14, 2023 09:33
Co-authored-by: Oliver Bertuch <poikilotherm@users.noreply.github.com>
Co-authored-by: Oliver Bertuch <poikilotherm@users.noreply.github.com>
@kcondon kcondon merged commit 5297ed3 into develop Feb 14, 2023
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from Ready for QA ⏩ to Done 🚀 Feb 14, 2023
@kcondon kcondon self-assigned this Feb 14, 2023
@pdurbin pdurbin modified the milestones: 5.14, 5.13 Feb 16, 2023
@pdurbin pdurbin deleted the 9332-5-13-release-notes branch August 15, 2023 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Write 5.13 release notes
7 participants