-
Notifications
You must be signed in to change notification settings - Fork 175
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
[Help Doc] Added help file for instrument data entry #6902
[Help Doc] Added help file for instrument data entry #6902
Conversation
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.
Hi Alex, thanks for adding generic instrument help text. I'll look at the specific wording in my next pass -- first, can you comment:
- Are you 200% sure you can't add Help text specifically for (e.g.) the BMI form (and only the BMI) because I think there was an expectation that Loris Help could still support that.
- How is [Raisinbread] No data for help editor module? #5691 resolved here? Can you address whether manual testing of the Help Editor's capabilities is working now, and post a screenshot?
@christinerogers This PR aims to resolve #5691 by adding a help file for the BMI instrument and then checking that Help Editor properly updates. I will take another crack at adding Help text specifically for the BMI instrument later today! Update: This PR no longer resolves #5691. A new PR has been created to resolve that issue (#6907) |
0ee429f
to
6014285
Compare
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.
Hey @AlexandraLivadas - looking at the purpose of this help text,
I think this can be condensed and simplified greatly (something we started with Help text with Alex Knoll, written up in her Help text guide) :
- see my 3 major edits
- delete everything below that - I don't think the content for each sample instrument is distinct enough to warrant the extra scrolling / re-reading.
Might you have time to do these easy changes this week? let us know...
Looks like @AlexandraLivadas hasn't had time for this in the past few weeks. @driusan are you comfortable doing final review? |
@AlexandraLivadas if you have time still could you pull, update and re-post the screenshot, showing how the current text renders? thanks! |
@driusan final review please |
this has not had travis run on it. |
@driusan Fixed, the last commit had the [skip ci] flag, probably because this PR only contains markdown changes. |
9af8c40
to
c53ce07
Compare
Add generic instrument help text for instruments that don't have customized help.
I added a markdown file under
modules/instruments/help/
so that Help instructions for the user will render when they are completing instrument data entry.Here is a screenshot of how the markdown renders in the frontend.
Testing instructions (if applicable)
Candidate
->Access Profile
and choose any candidate with associated instruments.?
Link to related issue