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

[Help Doc] Added help file for instrument data entry #6902

Merged

Conversation

AlexandraLivadas
Copy link
Contributor

@AlexandraLivadas AlexandraLivadas commented Aug 12, 2020

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.
Screen Shot 2020-08-12 at 2 43 56 PM

Testing instructions (if applicable)

  1. Checkout this branch and go to the LORIS frontend.
  2. Navigate to Candidate->Access Profile and choose any candidate with associated instruments.
  3. Navigate to the Data Entry page for any of the timepoint's instruments.
  4. Go to the top of the page and click on the ?
  5. View the markdown.

Link to related issue

@AlexandraLivadas AlexandraLivadas added the RaisinBread PR or issue introducing/requiring improvements to the Raidinbread dataset label Aug 12, 2020
Copy link
Contributor

@christinerogers christinerogers left a 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?

@AlexandraLivadas
Copy link
Contributor Author

AlexandraLivadas commented Aug 12, 2020

@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)

@AlexandraLivadas AlexandraLivadas added the State: Needs work PR awaiting additional work by the author to proceed label Aug 12, 2020
@AlexandraLivadas AlexandraLivadas changed the title [RB/Help] Added help file for instrument data entry [Help Doc] Added help file for instrument data entry Aug 12, 2020
@AlexandraLivadas AlexandraLivadas removed the request for review from ridz1208 August 12, 2020 22:21
@AlexandraLivadas AlexandraLivadas added Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...) and removed State: Needs work PR awaiting additional work by the author to proceed RaisinBread PR or issue introducing/requiring improvements to the Raidinbread dataset labels Aug 12, 2020
@AlexandraLivadas AlexandraLivadas force-pushed the 2020-08-12-addHelpFileForInstruments branch from 0ee429f to 6014285 Compare August 13, 2020 16:15
Copy link
Contributor

@christinerogers christinerogers left a 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...

modules/instruments/help/instruments.md Outdated Show resolved Hide resolved
modules/instruments/help/instruments.md Outdated Show resolved Hide resolved
modules/instruments/help/instruments.md Outdated Show resolved Hide resolved
@christinerogers
Copy link
Contributor

Looks like @AlexandraLivadas hasn't had time for this in the past few weeks.
I committed directly the last changes requested.

@driusan are you comfortable doing final review?

@christinerogers christinerogers added the Passed manual tests PR has been successfully tested by at least one peer label Oct 6, 2020
@christinerogers
Copy link
Contributor

@AlexandraLivadas if you have time still could you pull, update and re-post the screenshot, showing how the current text renders? thanks!

@christinerogers
Copy link
Contributor

@driusan final review please

@driusan
Copy link
Collaborator

driusan commented Nov 12, 2020

this has not had travis run on it.

@laemtl laemtl closed this Nov 17, 2020
@laemtl laemtl reopened this Nov 17, 2020
@laemtl
Copy link
Contributor

laemtl commented Nov 17, 2020

@driusan Fixed, the last commit had the [skip ci] flag, probably because this PR only contains markdown changes.

@laemtl laemtl force-pushed the 2020-08-12-addHelpFileForInstruments branch from 9af8c40 to c53ce07 Compare November 17, 2020 22:01
@driusan driusan merged commit 55a4cc6 into aces:main Nov 18, 2020
@ridz1208 ridz1208 added this to the 24.0.0 milestone Nov 27, 2020
AlexandraLivadas added a commit to AlexandraLivadas/Loris that referenced this pull request Jun 29, 2021
Add generic instrument help text for instruments that don't have customized help.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...) Passed manual tests PR has been successfully tested by at least one peer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Help Doc] No help document for the instruments module
6 participants