search

NCEAS / arctic-data-outreach

Outreach and engagement activities for the Arctic Data Center
Apache License 2.0
3 stars 4 forks source link

Data Editor - help text #22

Closed vlraymond closed 6 years ago

vlraymond commented 6 years ago

workflow & timeline:

vlraymond commented 6 years ago

needed, from Steph: "I think it would be helpful to have a very early-on instruction written somewhere about how to add attributes to your data files (clicking the describe button), because this step is separate from the dataset description fields that appear immediately below the files. I hope that makes sense how I've described it. the workflow of (1) upload your files, (2) fill out the dataset editor, (3) click "describe" to add more info about individual data files wasn't immediately apparent to me"

jesse [3:20 PM] https://github.com/NCEAS/metacatui/issues/440 "Steph’s point is more general than that issue, it’s just not obvious to do click “Describe” and I fear that a lot of submitters won’t unless we make it more clear"

needed, from Jesse: "we have some serious concerns about the lack of support for custom units on the current version of the new web form and the implications for the data team in terms of processing. the devs are aware of this existence of this issue, but maybe not the extent of the workload it may create on our end. at the least, we’d like to include some Helper language to notify submitters that they should contact us to tell us about any custom units"

from Irene: "we were also thinking of including help text to ask the PI's to use "dimensionless" as the unit and specify the actual unit in the attribute definition (this would be an alternative to email). we've come up with (a) asking the PI's to email us if they have this problem or (b) telling them to define as "dimensionless" as a placeholder and specify in the definition

vlraymond commented 6 years ago

@aebudden @mbjones what is the best workflow for this? I have started drafting new helper text for the Data Editor release but it should have input from everyone on the team.

proposed workflow & timeline:

laurenwalker commented 6 years ago

I think this looks like a good workflow. The repository for the eventual technical Github issue would be MetacatUI https://github.com/NCEAS/MetacatUI

vlraymond commented 6 years ago

remember to add in copy person instructions provided by Irene

aebudden commented 6 years ago

Can we change the order on the todo? I can't review by 3/10. Perhaps the support team can review first and I will review after. I will put it on my flight todo list for the weekend.

vlraymond commented 6 years ago

Sat down with Jesse, Mitchell, Irene, and Kathryn today and went over the helper text in detail. It's in pretty clean shape right now. Remaining points that are up for debate have comments. I have some final edits for sanity/consistency to do however this is ready for you @aebudden whenever you can.

I'll also notify the dev team so they can double check language for consistency with development plans, with EML, and consistency with other repositories.

vlraymond commented 6 years ago

from CJ & LW:

LW created a ticket for herself to go through and add this to the editor

vlraymond commented 6 years ago

VR looked at EML language and dropped pertinent quotes on role, role type in to the document. Not sure how to best describe these roles, may need Data team or Dev team to take lead here.

vlraymond commented 6 years ago

Closing this ticket as this language (albeit in truncated / refined form), has been incorporated in to the beta version of metadata editor now on arcticdata.io