Project

General

Profile

Actions
Copy link

Bug #21368

closed

Methods markdown documentation in the technique editor are not properly rendered

Added by Félix DALLIDET over 2 years ago. Updated about 2 years ago.

Status:
Released
Priority:
N/A
Assignee:
Vincent MEMBRÉ
Category:
Web - Technique editor
Target version:
7.1.7
Pull Request:
https://github.com/Normation/rudder/p...
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 open — 1 closed)

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

Updated by Félix DALLIDET over 2 years ago

  • Effort required set to Small
  • Priority changed from 62 to 70
Actions
Copy link
 #2

Updated by Alexis Mousset over 2 years ago

  • Subject changed from Methods markdown documentation in the technique editor are now properly rendered to Methods markdown documentation in the technique editor are not properly rendered
  • Priority changed from 70 to 139
Actions
Copy link
 #3

Updated by Vincent MEMBRÉ over 2 years ago

  • Target version changed from 7.2.0~beta1 to 7.2.0~rc1
Actions
Copy link
 #4

Updated by François ARMAND over 2 years ago

  • Severity changed from Critical - prevents main use of Rudder | no workaround | data loss | security to Minor - inconvenience | misleading | easy workaround
  • Priority changed from 139 to 96
Actions
Copy link
 #5

Updated by Nicolas CHARLES over 2 years ago

it happens in 7.0 and 7.1 also

Actions
Copy link
 #7

Updated by Alexis Mousset over 2 years ago

  • Target version changed from 7.2.0~rc1 to 7.1.5
  • Priority changed from 96 to 143
  • Regression set to No
Actions
Copy link
 #8

Updated by Vincent MEMBRÉ over 2 years ago

  • Target version changed from 7.1.5 to 7.1.6
  • Priority changed from 143 to 142
Actions
Copy link
 #9

Updated by Elaad FURREEDAN over 2 years ago

  • Assignee set to Elaad FURREEDAN
Actions
Copy link
 #10

Updated by Vincent MEMBRÉ over 2 years ago

  • Target version changed from 7.1.6 to 7.1.7
Actions
Copy link
 #11

Updated by Alexis Mousset over 2 years ago

  • Assignee changed from Elaad FURREEDAN to Alexis Mousset
Actions
Copy link
 #12

Updated by Alexis Mousset over 2 years ago

  • Status changed from New to In progress
Actions
Copy link
 #13

Updated by Alexis Mousset over 2 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
Copy link
 #14

Updated by Alexis Mousset over 2 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
Copy link
 #15

Updated by Alexis Mousset over 2 years ago

  • Status changed from Pending technical review to Pending release
Actions
Copy link
 #16

Updated by Nicolas CHARLES over 2 years ago

  • Priority changed from 142 to 140
  • Fix check changed from To do to Checked
Actions
Copy link
 #17

Updated by Elaad FURREEDAN about 2 years ago

  • Has duplicate Bug #20691: Some generic method docs are badly formatted added
Actions
Copy link
 #18

Updated by Vincent MEMBRÉ about 2 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
Copy link

Also available in: Atom PDF