Project

General

Custom queries

Profile

Actions

Bug #21368

closed

Methods markdown documentation in the technique editor are not properly rendered

Added by Félix DALLIDET about 3 years ago. Updated almost 3 years ago.

Status:
Released
Priority:
N/A
Category:
Web - Technique editor
Target version:
Severity:
Minor - inconvenience | misleading | easy workaround
UX impact:
I hate Rudder for that
User visibility:
First impressions of Rudder
Effort required:
Small
Priority:
139
Name check:
To do
Fix check:
Checked
Regression:
No

Description

This is very frustrating. I can not find anywhere a readable documentation of the methods. The documentation is broken on the online website and it is also broken in the technique editor.


Files

clipboard-202207131708-romto.png (200 KB) clipboard-202207131708-romto.png Nicolas CHARLES, 2022-07-13 17:08

Related issues 1 (0 open1 closed)

Has duplicate Rudder - Bug #20691: Some generic method docs are badly formattedResolvedActions
Actions #5

Updated by Nicolas CHARLES about 3 years ago

it happens in 7.0 and 7.1 also

Actions #13

Updated by Alexis Mousset almost 3 years ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Alexis Mousset to Vincent MEMBRÉ
  • Pull Request set to https://github.com/Normation/rudder/pull/4471
Actions #14

Updated by Alexis Mousset almost 3 years ago

The previous lib did require an empty line before lists and did not handle nested lists, which is required for ncf doc. Switch to another library which implements CommonMark and hence fits our needs.

Actions #15

Updated by Alexis Mousset almost 3 years ago

  • Status changed from Pending technical review to Pending release
Actions #18

Updated by Vincent MEMBRÉ almost 3 years ago

  • Status changed from Pending release to Released
  • Priority changed from 140 to 139

This bug has been fixed in Rudder 7.1.7 and 7.2.1 which were released today.

Actions

Also available in: Atom PDF