microbiomedata / nmdc-schema

National Microbiome Data Collaborative (NMDC) unified data model
https://microbiomedata.github.io/nmdc-schema/
Creative Commons Zero v1.0 Universal
27 stars 8 forks source link

add display hint annotations for study slots that appear on study submission portal #267

Open turbomam opened 2 years ago

turbomam commented 2 years ago

@dehays @subdavis @cmungall

turbomam commented 2 years ago

see

Some of the text entry boxes on the study submission portal page may need better display hints despite the fact that they're not modeled in the nmdc schema

turbomam commented 2 years ago
poetry run gen-linkml --format json --materialize-attributes src/schema/nmdc.yaml > nmdc_MAM.linkml.json

or

make target/json/nmdc.linkml.json

notes: there are embedded carriage returns in schema description

Added columns to @mslarae13's spreadsheet:

turbomam commented 2 years ago

study.slot_usage.name.annotations.display_hint = "Provide a name for the study your samples will belong with."

same content was already in study.slot_usage.name.description, so review descriptions to really contain descriptions

turbomam commented 2 years ago

Should these be written with a preceding verb phrase like "Enter the width of you swimming pool" or just "width of you swimming pool"

We should be consistent

turbomam commented 2 years ago

we're hinting about how to enter something, not hinting on how to display it

tooltips for data entry

turbomam commented 2 years ago

Could we put actual DOM paths into column A or B in SubmissionPortal_TermUpdates? Or anything else that's verifiable?