DMPRoadmap / roadmap

DCC/UC3 collaboration for a data management planning tool
MIT License
102 stars 109 forks source link

Duplicate 'guidance' in guidance name #333

Closed sjDCC closed 7 years ago

sjDCC commented 7 years ago

The DCC guidance entries are showing with the word guidance twice e.g. guidance-duplication

This typically happens if the guidance group name is "Institution guidance" as this is then appended on to text that reads "guidance on [theme name]. There used to be something in the code that removed duplicate entries of the word guidance so this perhaps needs to be reinstated?

vyruss commented 7 years ago

Perhaps we can add a colon in between? Writing code to see if the person writing the guidance group name and the guidance name has included the same word at the end of one and the beginning of the other is bad practice IMHO as we'd be solving a problem which is not ours.

vyruss commented 7 years ago

@sjDCC how does this look? (on dmponline-test)

sjDCC commented 7 years ago

I would prefer it if we didn't have two entries of 'guidance' together as it still looks like a duplication. guidance

How about we remove the text 'guidance on' before the theme name. That should work whether or not the uni guidance group name includes the word guidance e.g.

Edinburgh guidance: data sharing Edinburgh: data sharing

What do you think @stephaniesimms?

vyruss commented 7 years ago

@sjDCC this is clearly a data issue and not something for us to solve. If they want to avoid guidance: guidance then they should change their titles!

sjDCC commented 7 years ago

Yes, I know. My approach was just to try and reduce helpdesk tickets and avoid having to provide lots of user guidance. We used to have a rule that filtered the duplication out so people will be confused to see it again.

Will see what @stephaniesimms prefers and we'll either add more user guidance or remove "guidance on". Either will work.

vyruss commented 7 years ago

@sjDCC we can always run a nice clean-up database query that will change all titles from "Guidance on tropical diseases" to "Tropical diseases"...

stephaniesimms commented 7 years ago

I keep going back and forth on this. Let me check with UX. Personally I prefer to keep our own Guidance header and instruct admins to remove it from their user guidance, but this could prove difficult in practice as @sjDCC noted. Maybe we can find a better, lightweight approach (e.g., a tooltip) to instruct admins as they're creating guidance...

sjDCC commented 7 years ago

Ok, let's rework the tooltip text on adding guidance groups and close this out. Can you do that today @vyruss?

Here's what it currently says: tooltip

Let's replace with:

Add an appropriate name for your guidance group. This name will be used to tell the end user where the guidance has come from. It will be appended to text identifying the theme e.g. "[guidance group name]: guidance on data sharing" so we suggest you just use the institution or department name.

vyruss commented 7 years ago

Done

sjDCC commented 7 years ago

Tested and looks good. Closing out.