Project

General

Profile

Actions

Bug #21368

open

Methods markdown documentation in the technique editor are not properly rendered

Added by Félix DALLIDET 3 months ago. Updated 6 days ago.

Status:
Pending release
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:
140
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
Actions #1

Updated by Félix DALLIDET 3 months ago

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

Updated by Alexis Mousset 3 months 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 #3

Updated by Vincent MEMBRÉ 3 months ago

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

Updated by François ARMAND 3 months 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 #5

Updated by Nicolas CHARLES 3 months ago

it happens in 7.0 and 7.1 also

Actions #7

Updated by Alexis Mousset about 1 month ago

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

Updated by Vincent MEMBRÉ about 1 month ago

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

Updated by Elaad FURREEDAN 28 days ago

  • Assignee set to Elaad FURREEDAN
Actions #10

Updated by Vincent MEMBRÉ 28 days ago

  • Target version changed from 7.1.6 to 7.1.7
Actions #11

Updated by Alexis Mousset 22 days ago

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

Updated by Alexis Mousset 22 days ago

  • Status changed from New to In progress
Actions #13

Updated by Alexis Mousset 22 days 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 22 days 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 22 days ago

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

Updated by Nicolas CHARLES 6 days ago

  • Priority changed from 142 to 140
Actions

Also available in: Atom PDF