Project

General

Profile

Actions

Bug #23491

closed

LONG_DESCRIPTION field of techniques seems to be ignored

Added by Félix DALLIDET 8 months ago. Updated 7 months ago.

Status:
Released
Priority:
N/A
Category:
Techniques
Target version:
Severity:
Minor - inconvenience | misleading | easy workaround
UX impact:
It bothers me each time
User visibility:
Getting started - demo | first install | Technique editor and level 1 Techniques
Effort required:
Priority:
62
Name check:
To do
Fix check:
To do
Regression:
No

Description

It seems that we are now using the "DESCRIPTION" field of the metadata as documentation AND tooltip on the directive webpage.
I am pretty sure it should instead be mapped this way:

  • DESCRIPTION -> tooltip displayed when passing the mouse over the technique name in the directive webpage
  • LONG_DESCRIPTION -> Markdown rendered documentation of the technique, only displayed when editing a directive

Note that on ncf_techniques, the documentation field is not rendered in the metadata.


Related issues 1 (0 open1 closed)

Related to Rudder - Bug #23519: In the directive page, the description of the technique is the name of the techniqueResolvedActions
Actions #1

Updated by Alexis Mousset 8 months ago

  • Status changed from New to In progress
  • Assignee set to Alexis Mousset
Actions #2

Updated by Alexis Mousset 8 months ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Alexis Mousset to Félix DALLIDET
  • Pull Request set to https://github.com/Normation/rudder/pull/5059
Actions #3

Updated by Alexis Mousset 8 months ago

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

Updated by Vincent MEMBRÉ 7 months ago

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 8.0.0~beta3 which was released today.

Actions #5

Updated by Nicolas CHARLES 7 months ago

  • Related to Bug #23519: In the directive page, the description of the technique is the name of the technique added
Actions

Also available in: Atom PDF