Project

General

Profile

action #45413

[tools][functional][y] Support markdown in the test suites description

Added by riafarov over 1 year ago. Updated about 1 year ago.

Status:
Blocked
Priority:
Normal
Assignee:
Category:
Feature requests
Target version:
Start date:
2018-12-19
Due date:
% Done:

0%

Estimated time:
13.00 h
Difficulty:
Duration:

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

Blocked by openQA Project - action #44360: [epic] Parameterize test suites within job groupsBlocked2019-01-252020-11-27

History

#1 Updated by okurz over 1 year ago

  • Subject changed from [tools] Support MD in the test suites desscription to [tools] Support markdown in the test suites description

#2 Updated by riafarov over 1 year ago

  • 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

#3 Updated by JERiveraMoya over 1 year ago

  • Assignee set to JERiveraMoya

#4 Updated by JERiveraMoya over 1 year ago

  • Assignee deleted (JERiveraMoya)

#5 Updated by JERiveraMoya over 1 year ago

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.

#6 Updated by riafarov over 1 year ago

  • Description updated (diff)
  • Estimated time set to 13.00 h

#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.

#9 Updated by JERiveraMoya over 1 year ago

  • Blocks action #44360: [epic] Parameterize test suites within job groups added

#10 Updated by JERiveraMoya over 1 year ago

  • Blocks deleted (action #44360: [epic] Parameterize test suites within job groups)

#11 Updated by JERiveraMoya over 1 year ago

  • Blocked by action #44360: [epic] Parameterize test suites within job groups added

#12 Updated by JERiveraMoya over 1 year ago

  • Status changed from In Progress to Blocked

#13 Updated by oorlov over 1 year ago

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.

#14 Updated by okurz over 1 year ago

  • Due date deleted (2019-02-12)
  • Target version set to future

this will take some time until the blocker is resolved

#15 Updated by okurz about 1 year ago

  • Category changed from 124 to Feature requests

Also available in: Atom PDF