-
Notifications
You must be signed in to change notification settings - Fork 492
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
8127 citation field improvements #8708
Conversation
Closes #8127 Changes the labels, tooltips and watermarks of fields shown in the Citation metadatablock to improve readability
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed a couple small things in the docs. Please see the review.
I didn't run the code but the tests pass. I eyeballed the changes and nothing jumped out at me as wrong.
Changing metadatablocks to metadata blocks since metadata blocks (with a space is used everywhere else in the guides). Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>
Removing line about bootstrap. Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>
@jggautier I think for the upgrade instructions in the release notes, needs to mention copying over/updating the Bundle.properties and citation.properties, no? Or does that happen automatically due to those being defaults? Happens automatically. Closing. |
What this PR does / why we need it:
This PR makes grammar, style and consistency improvements to the titles, descriptions/tooltips and watermarks of all metadata fields that appear in the Citation metadata block.
This includes edits to fields that appear in the Citation Metadata accordions (controlled by the citation.tsv and citation.properties files) and whose values are system-generated, like the Dataset Persistent ID, Previous Dataset Persistent ID, and Publication Date fields (controlled by the bundles.properties file).
The changes should provide clearer information to curators, depositors, and people looking for data about what the fields are for.
It also adds a new page in the Style Guides called "Text" that includes a section called "Metadata Text Guidelines", which includes a link to the Google Doc where the guidelines are being maintained for now since we expect them to be revised frequently.
Lastly it makes changes to a few other pages in the Guides to update the names of the Citation block fields that those pages mention.
Which issue(s) this PR closes:
Closes #8127
Special notes for your reviewer:
Suggestions on how to test this:
Reload the Citation metadatablock. See the Reloading a Metadata Block section of the Admin guide.
Create and edit a dataset to spot check that the titles, descriptions/tooltips and watermarks of fields shown on the following pages have changed:
The spreadsheet at https://docs.google.com/spreadsheets/d/1sHRvSpGSF0XfKTp4nWxT0zX4z8TORcuX7DTDrktOorg shows what the field titles, tooltips and watermarks were and, if they've been changed, how they've been changed. I wouldn't suggest checking all changes, since every description/tooltip has been edited. I hope checking a few on each page would be enough to spot any problems.
Check the Style Guide to make sure its Contents list includes a link to the "Text" page and check that clicking on that link takes you to the Text page, which should include a "Metadata Text Guidelines" section.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Yes, the mockups below show some of the changes to the field titles and watermarks. The tooltips are shy (they appear only one at a time when hovering over or touching them) so it's tougher to show their changes in the same way, but all of the changes can be seen in the spreadsheet at https://docs.google.com/spreadsheets/d/1sHRvSpGSF0XfKTp4nWxT0zX4z8TORcuX7DTDrktOorg.
Below those images are mockups of the changes to the Style Guide.
Mockups of changes to the Style Guides page
Is there a release notes update needed for this change?:
Yes, the changes are mentioned in the included 8127-citation-field-improvements.md