action #45413
closed
Support markdown in the test suites description
Added by riafarov over 5 years ago.
Updated over 3 years ago.
Category:
Feature requests
Description
Motivation¶
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.
Suggestions¶
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.
Related issues
1 (1 open — 0 closed)
- Subject changed from [tools] Support MD in the test suites desscription to [tools] Support markdown in the test suites description
- Subject changed from [tools] Support markdown in the test suites description to [tools][functional][y] Support markdown in the test suites description
- Due date set to 2019-02-12
- Status changed from New to Workable
- Assignee set to JERiveraMoya
- Assignee deleted (
JERiveraMoya)
I was checking and it looks like we could use functionality from comments (that have already markdown language) in the textarea with description but it seems to require a lot of changes in javascript and templates. I'd like to pair up with someone as there are too many things new for me there I believe.
- Description updated (diff)
- Estimated time set to 13.00 h
- Assignee set to JERiveraMoya
- 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.
- Status changed from In Progress to Blocked
Postponed because of poo#44360.
The parameterization will likely cause some restructuring in that area and additionally the table is already too slow in its current state so we should not make it even slower.
- Due date deleted (
2019-02-12)
- Target version set to future
this will take some time until the blocker is resolved
- Category changed from 124 to Feature requests
- Subject changed from [tools][functional][y] Support markdown in the test suites description to [functional][y] Support markdown in the test suites description
QA tools teams tracks all tickets in openQA project, no need for additional team tag
- Subject changed from [functional][y] Support markdown in the test suites description to Support markdown in the test suites description
- Status changed from Blocked to New
- Assignee deleted (
JERiveraMoya)
- Status changed from New to Rejected
- Assignee set to okurz
Our current approach, also linked to #44360 , is rather to move the test suite definitions also into YAML documents. Markdown could still be put within YAML strings within mentioned documents though.
Also available in: Atom
PDF