Bug 1865928

Summary:	Templates documentation help page has hard-coded Satellite setting value
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:	medium	Docs Contact:
Priority:	medium
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

Description Mirek Długosz 2020-08-04 14:39:42 UTC

In templates DSL documentation (bz#1819150), on `help.html` page, there is reference to actual Satellite setting at the very bottom:

> In order to disable Safe mode, navigate to Administer -> Settings -> Provisioning tab and search for a setting called "Safemode rendering". Value "No" means, rendering is unprotected and potentially dangerous. This installation has currently safe mode: enabled.


Since docs are generated and stored outside of customer Satellite instance (for now), docs can't tell actual value of setting in question. This is potentially misleading for customer reading this page.

I know this paragraph is well-meaning, but I believe it's best to drop it for now. Just tell customer where she can find setting value.


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:16:23 UTC

Paragraph at the bottom of help page doesn't have potentially misleading sentence. Entire paragraph now reads:

> In order to disable Safe mode, navigate to Administer -> Settings -> Provisioning tab and search for a setting called "Safemode rendering". Value "No" means, rendering is unprotected and potentially dangerous.



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

Comment 5 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