E-mail alerts: review wording of alerts for experiment assets

[aislinnpearson]

Following my comment here, there are a couple of places where my wording in the e-mail alerts for the experiment assets could be better. This is just a reminder to review them in the next push.

[aislinnpearson]

Hi @paul121,

Here are the minor edits I'd suggest. I have also copied and pasted an example of how the e-mails are rendering internally for each to give you an idea of what people are seeing. They should look tidier still when we address issue #639. Please feel free to check my spelling and grammar - or simplify what I have written further if you can see obvious improvements! I'm also going to leave one comment here for each entity, because otherwise it gets a bit confusing.

I've attached the actual updated document here, but also included screenshots to make it nice and easy to see the changes: E-mail Alerts - Alerts for NEW Research Entities.pdf

Researcher: No changes. Currently rendering as below

[aislinnpearson]

Research Program:

The name of the Programs can be pretty long which makes it look untidy when it renders, so I was thinking maybe we could remove the link and have a generic title. I also found a few typos.

Currently rendering as:

Suggested changes:

[aislinnpearson]

Research Proposals:

No changes. Currently rendering as:

[aislinnpearson]

Experiments:

No changes. Currently rendering as:

[aislinnpearson]

Designs:

Again the name of the Designs can be pretty long which makes it look untidy when it renders, so I was thinking maybe we could remove the link and have a generic title. The way the name of the experiment renders next to the design link is also a bit confusing, and I don't the experiment name needs to be mentioned twice. I was wondering if something like this might improve things:

Currently rendering as:

[aislinnpearson]

Plans:

All the same issues as mentioned for the Design entity above, so I edited to be in keeping with those changes:

Currently rendering as:

[aislinnpearson]

Logs:

The log name is a bit strange in the way it renders in the email title, and then I thought it might be good to follow a similar convention to that for the experiments, designs and plans?

Currently rendering as:

[paul121]

The log name is a bit strange in the way it renders in the email title, and then I thought it might be good to follow a similar convention to that for the experiments, designs and plans?

This makes sense but its actually challenging to load the associated experiment (there could be multiple!) when building the email for logs. I'll make the change for the subject line but keep the body text the same for now.

[aislinnpearson]

This makes sense but its actually challenging to load the associated experiment (there could be multiple!) when building the email for logs. I'll make the change for the subject line but keep the body text the same for now.

No worries Paul. I'm happy with this

[aislinnpearson]

I found a very small issue here with colons... do we think it is worth fixing in this release @paul121? Other than that, I am happy to sign this off.

[aislinnpearson]

We agreed that this would look best in rich text (see #626) but this is a visualisation issue.

In the mean time we correct these two grammatical errors by:

1. replacing the highlighted colon on the Design with a full stop
2. Putting the experiment design name on the plan in quotation marks

This can go in the 2.20.0 release

[paul121]

1. replacing the highlighted colon on the Design with a full stop

Oh sorry @aislinnpearson , I think I misunderstood what you meant by this. I'm quite happy to change this but just wanted to mention that I'm using this pattern (ending with colon, not a full stop) for most of the entity types in both the new + updated emails.

The general format is:

A {entity type} as been added {to relevant entity type} by {author}: or {Author} has edited a {entity type} you are associated with:

You can see it in the other "Added a Plan" email example you shared:

A Plan has been added to the above Experiment Design by Aislinn:

The rationale for this is that the actual entity + a link for the entity will follow this sentence. I think this would all make more sense if we had a rich-text hyperlink to the entity in question immediately following the colon... but in the meantime I'm happy to change all of these to a full stop if you would prefer! What do you think @aislinnpearson ?

[paul121]

2. Putting the experiment design name on the plan in quotation marks

I have made this change

[aislinnpearson]

Hey @paul121

The rationale for this is that the actual entity + a link for the entity will follow this sentence. I think this would all make more sense if we had a rich-text hyperlink to the entity in question immediately following the colon... but in the meantime I'm happy to change all of these to a full stop if you would prefer!

I am happy with this. Better to be consistent right? I am kicking myself though because I saw this after making the changes to #605

I can amend the specifications... but will leave the comments if that is okay?

[paul121]

I can amend the specifications... but will leave the comments if that is okay?

Thank you for the detailed comments! This is done.