Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 2187303

Summary:	[DDF] Clean up deployment procedures in documentation
Product:	Service Telemetry Framework	Reporter:	Direct Docs Feedback <ddf-bot>
Component:	Documentation	Assignee:	mgeary <mgeary>
Status:	CLOSED ERRATA	QA Contact:	Alex Yefimov <ayefimov>
Severity:	low	Docs Contact:	mgeary <mgeary>
Priority:	low
Version:	1.5	CC:	ayefimov, lmadsen, lnatapov
Target Milestone:	z2	Keywords:	Documentation, Triaged, ZStream
Target Release:	1.5 (STF)
Hardware:	All
OS:	All
Whiteboard:
Fixed In Version:		Doc Type:	No Doc Update
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2023-06-22 19:06:01 UTC	Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Direct Docs Feedback 2023-04-17 12:15:22 UTC

Putting the command in a format that I can copy and past would be easier:


and 
"--environment-file  \"  are not conveniently placed in the documentation.

Reported by: rhn-support-ayefimov

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/service_telemetry_framework_1.5/assembly-completing-the-stf-configuration_assembly#annotations:f476d277-9255-4687-bde3-529eeb77c9c4

Comment 1 Leif Madsen 2023-04-18 14:41:12 UTC

Do you have a suggested format? I'm not really sure how to change this other than to make it a long single line.

Comment 2 Alex Yefimov 2023-04-18 16:05:17 UTC

As I see it there are two issues here. First issue, when I copy the content I get:

"(undercloud) [stack@undercloud-0 ~]$" is not part of the command and is always edited out.

Second Issue:

"<other_arguments>"

and 

"--environment-file <...other_environment_files...> \"

Are extra information and should not be in the copy box. Make notes above and below to fill in the rest of the info [which has value]

Proposed change:


(undercloud) [stack@undercloud-0 ~]$ 
********************************************* copy box ************************************************************** 
openstack overcloud deploy                                                                                          *
--templates /usr/share/openstack-tripleo-heat-templates \                                                           *
  --environment-file /usr/share/openstack-tripleo-heat-templates/environments/metrics/ceilometer-write-qdr.yaml \   *
  --environment-file /usr/share/openstack-tripleo-heat-templates/environments/metrics/qdr-edge-only.yaml \          * 
  --environment-file /home/stack/enable-stf.yaml \                                                                  *
  --environment-file /home/stack/stf-connectors.yaml                                                                * 
********************************************* copy box **************************************************************  


Please note that this issue has many instances in the document

Comment 9 errata-xmlrpc 2023-06-22 19:06:01 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 (Release for Service Telemetry Framework 1.5.2), 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/RHEA-2023:3785