training-material icon indicating copy to clipboard operation
training-material copied to clipboard

GTN Feedback page: Links needed for each item under topics

Open Ahuoyiza opened this issue 3 years ago • 2 comments

What is the issue?

The GTN feedback page currently only links back to the topics. The specific tutorial(s) that got feedback doesn't have a direct link to it and this makes it difficult for contributors to easily access the said tutorial and address issues.

Suggestion

  1. ~~In the form, users can be asked to drop a link to the tutorial they are giving feedback or~~
  2. ~~We automate form submission to store source URL~~

Benefits:

  1. Contributors will easily link back to tutorials with feedbacks
  2. Fix time will be reduced

Ahuoyiza avatar Nov 05 '21 09:11 Ahuoyiza

In the form, users can be asked to drop a link to the tutorial they are giving feedback or

This is already done, and automated! It's hidden in the form so it isn't visible to users and they can't accidentally change it. This line includes the tutorial + topic title: https://github.com/galaxyproject/training-material/blob/main/_layouts/tutorial_hands_on.html#L268

And you'll see in our feedback.csv file that's in the repository we have columns for both the tutorial + topic, so, it should all already be connected. https://github.com/galaxyproject/training-material/blob/main/metadata/feedback.csv

But I'm worried I misunderstand your suggestions section? Because you correctly point out that in the feedback page (e.g. https://training.galaxyproject.org/training-material/feedback.html#tutorial-unicycler-assembly) it is missing a link to the specific tutorial. That would be very easy to fix as well.

hexylena avatar Nov 05 '21 10:11 hexylena

Oh, since the form is automated to do that already, then that won't be necessary as a suggestion.

But yes, the existing issue is the missing link to tutorials Quick issue demo here

Ahuoyiza avatar Nov 05 '21 12:11 Ahuoyiza