Bug 1866029

Summary:

Templates DSL documentation: Parts of description are put in <pre> tag

Product:

Red Hat Satellite

Reporter:

Mirek Długosz <mzalewsk>

Component:

Provisioning Templates

Assignee:

satellite6-bugs <satellite6-bugs>

Status:

CLOSED ERRATA

QA Contact:

Mirek Długosz <mzalewsk>

Severity:

low

Docs Contact:

Priority:

low

Version:

6.8.0

CC:

mhulan, pcreech

Target Milestone:

6.8.0

Keywords:

Triaged

Target Release:

Unused

Hardware:

Unspecified

OS:

Unspecified

Whiteboard:

Fixed In Version:

Doc Type:

If docs needed, set a value

Doc Text:

Story Points:

---

Clone Of:

Environment:

Last Closed:

2020-10-27 13:05:07 UTC

Type:

Bug

Regression:

---

Mount Type:

---

Documentation:

---

CRM:

Verified Versions:

Category:

---

oVirt Team:

---

RHEL 7.3 requirements from Atomic Host:

Cloudforms Team:

---

Target Upstream Version:

Embargoed:

Bug Depends On:

Bug Blocks:

1819150

Attachments:

Description	Flags
Sample page with description in <pre> tag	none
Same page - after fix	none

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