Project

General

Profile

Actions

Bug #28289

closed

Remove images in API doc

Bug #28289: Remove images in API doc

Added by Alexis Mousset 7 months ago. Updated 7 months ago.

Status:
Released
Priority:
N/A
Category:
Documentation
Target version:
Severity:
UX impact:
User visibility:
Effort required:
Priority:
0
Name check:
To do
Fix check:
Checked
Regression:
No

Description

When clicking on a link pointing to a section in the API doc (redoc version) in Firefox, the section sometimes changes in the URL after page load, due to https://github.com/Redocly/redoc/issues/896.

This is due to the presence of images which, on Firefox only, cause a scroll event. When the section changes, the view switches to the previous section. This is a serious issue as users often open links to URL docs.

An obvious fix is to remove the images for now.

Updated by Alexis Mousset 7 months ago Actions #1

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

Updated by Alexis Mousset 7 months ago Actions #2

  • 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/6880

Updated by Alexis Mousset 7 months ago Actions #3

  • Status changed from Pending technical review to Pending release

Updated by François ARMAND 7 months ago Actions #4

  • Fix check changed from To do to Checked

Updated by Vincent MEMBRÉ 7 months ago Actions #5

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 8.3.9 and 9.0.4 which were released today.

Actions

Also available in: PDF Atom