[tools][functional][y] Support markdown in the test suites description
I as a test developer would like to provide good description of the test suites and test scenarios. With MD I can use better formatting so it's easier to read description.
As a PM I would like to have better test suite descriptions which are easy to read and follow. Without proper paragraphs it's hard to read something longer than 2-3 sentences which is not enough.
Reuse what we already have for comments in the job, as well as job group details, so we can have same formatter.
We need also to assure that pop-ups with test suite descriptions we have when put the cursor on the test suite (hover overview).
Also, evaluate that MD in description is properly rendered when used in the template for bug/progress ticket creation.
#5 Updated by JERiveraMoya over 1 year ago
#7 Updated by JERiveraMoya over 1 year ago
- Assignee set to JERiveraMoya
Perl template creating the comments: https://github.com/os-autoinst/openQA/blob/master/templates/comments/comment_row.html.ep#L36
Perl doing the markdown thingy: https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/Schema/Result/Comments.pm#L150
#8 Updated by JERiveraMoya over 1 year ago
- Status changed from Workable to In Progress
Agreed with oorlov that the change is not trivial, as currently all the tables use generic method to populate them. But for our current task, we need to distinguish certain column. And in order to design it properly we need to ask Marius and discuss all three together.
Setting my dev env for openQA in the meantime.