search

ChildMindInstitute / MindLogger-bug-reports

GitHub repository for bug tracking and feature requesting for the MindLogger project
Other
0 stars 1 forks source link

✨ Clarify invitation language #45

Closed shnizzedy closed 3 years ago

shnizzedy commented 5 years ago

Additional context Ideally, we'd do #16 and store all of this text in language-tagged Objects in the database, but time constraints have negated that possibility for now. The method that currently assembles that HTML is Invitation().htmlInvitation.

In the sample invitation below, the sources of the text are highlighted as follows:

highlighted example invitation

The yellow sections, in sequence:

  1. If the invitation includes a displayName, say "Arno", the invitation starts with that name, eg. "Arno, you have been…". Otherwise, the invitation starts with a captial-y "You have been…".
  2. The name and email address of the coordinator or manager who created the invitation.
  3. The name of the database serving the applet.
  4. The name and email address of each reviewer for the applet.
  5. The name and email address of each manager for the applet.
  6. The name and email address of each coordinator for the applet.
  7. The link to access the invitation on MindLoggger web.

All of the markup is included in the htmlInvitation method.

shnizzedy commented 5 years ago

Related https://github.com/ChildMindInstitute/MindLogger-bug-reports/issues/43

binarybottle commented 5 years ago

@shnizzedy -- where in the database would {greeting} be stored? That's the part I wanted to look at.

shnizzedy commented 5 years ago

@binarybottle when an invitation is created, a displayName can be included. If one is,

the invitation starts with that name, eg. "Arno, you have been…". Otherwise, the invitation starts with a captial-y "You have been…".

― https://github.com/ChildMindInstitute/MindLogger-bug-reports/issues/45#issue-525989920

greeting is just a kwarg for the str.format method that checks for a displayName in the invitation and conditionally includes before "ou have been" either (true) that name, a comma, and a 'y' or (false) a 'Y':

https://github.com/ChildMindInstitute/mindlogger-app-backend/blob/7820cb4b2414bd6c8841858948a91803c7039ae2/girderformindlogger/models/invitation.py#L301-L303

shnizzedy commented 5 years ago

Invitations are created with POST /applet/{id}/invite

binarybottle commented 5 years ago

Okay, so I could simply add some text preceding this, for example: "Welcome! "

binarybottle commented 5 years ago

I just added a PR (#239) to update some of the text.

I recommend adding space above "Description" and making it boldface in:

Welcome Arno; you have been invited by Jon (jon.clucas@childmind.org) to Healthy Brain Network self-report internal test on MindLogger. Description

shnizzedy commented 5 years ago

:point_up_2: @henryrossiter

WorldImpex commented 3 years ago

It doesn't look like there is a scope of work here any longer so closing