Bug 1866029 - Templates DSL documentation: Parts of description are put in <pre> tag
Summary: Templates DSL documentation: Parts of description are put in <pre> tag
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Provisioning Templates
Version: 6.8.0
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: 6.8.0
Assignee: satellite6-bugs
QA Contact: Mirek Długosz
URL:
Whiteboard:
Depends On:
Blocks: 1819150
TreeView+ depends on / blocked
 
Reported: 2020-08-04 17:07 UTC by Mirek Długosz
Modified: 2020-10-27 13:06 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-10-27 13:05:07 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
Sample page with description in <pre> tag (90.98 KB, image/png)
2020-08-04 17:07 UTC, Mirek Długosz
no flags Details
Same page - after fix (80.33 KB, image/png)
2020-09-04 11:27 UTC, Mirek Długosz
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHSA-2020:4366 0 None None None 2020-10-27 13:06:12 UTC

Description Mirek Długosz 2020-08-04 17:07:52 UTC
Created attachment 1710389 [details]
Sample page with description in <pre> tag

In templates DSL documentation (bz#1819150), parts of description are sometimes put in <pre> tag and rendered as code.

For one of examples see `/dsldoc/all/Foreman::Renderer::Scope::Macros::Loaders/load_hosts.html`. There is "code" in main description on top, and then in "includes" and "joins" parameters description.
See also attached screenshot.


In foreman source code, I see these strings are broken into multiple lines (to prevent code editor from wrapping them), and second and later lines are indented. Looks like documentation generator runs these strings through markdown parser, which in turn considers lines indented by more than 4 spaces to be "preformatted".


Adding blocks on bz#1819150 to maintain relation between these two, but I wouldn't say this "must" be resolved first.

Comment 2 Mirek Długosz 2020-09-04 11:27:18 UTC
Created attachment 1713766 [details]
Same page - after fix

Comment 3 Mirek Długosz 2020-09-04 11:30:18 UTC
Unnecessary <pre> tags in description are no longer present. Text is no longer presented as preformatted, it's normal text instead. See "Same page - after fix" attachment.

Tested on documentation version available as of September 4, 2020.

Comment 6 errata-xmlrpc 2020-10-27 13:05:07 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Important: Satellite 6.8 release), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2020:4366


Note You need to log in before you can comment on or make changes to this bug.