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.
Category:
Web - Technique editor
Severity:
Minor - inconvenience | misleading | easy workaround
UX impact:
I hate Rudder for that
User visibility:
First impressions of Rudder
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
- Effort required set to Small
- Priority changed from 62 to 70
- 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
- Target version changed from 7.2.0~beta1 to 7.2.0~rc1
- 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
it happens in 7.0 and 7.1 also
see in 7.0
- Target version changed from 7.2.0~rc1 to 7.1.5
- Priority changed from 96 to 143
- Regression set to No
- Target version changed from 7.1.5 to 7.1.6
- Priority changed from 143 to 142
- Assignee set to Elaad FURREEDAN
- Target version changed from 7.1.6 to 7.1.7
- Assignee changed from Elaad FURREEDAN to Alexis Mousset
- Status changed from New to In progress
- 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
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.
- Status changed from Pending technical review to Pending release
- Priority changed from 142 to 140
- Fix check changed from To do to Checked
- Has duplicate Bug #20691: Some generic method docs are badly formatted added
- 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.
Also available in: Atom
PDF
Updated by 
Updated by 
Updated by 
Updated by 
Updated by 
Updated by