Bug 2228871

Summary:	[DDF] This section doesn't correctly use markups.
Product:	Red Hat Enterprise Linux 9	Reporter:	Direct Docs Feedback <ddf-bot>
Component:	Documentation	Assignee:	Mayur Patil <maypatil>
Documentation sub component:	DDF	QA Contact:
Status:	NEW ---	Docs Contact:
Severity:	unspecified
Priority:	medium	CC:	rhel-docs
Version:	unspecified	Keywords:	Documentation
Target Milestone:	rc
Target Release:	---
Hardware:	All
OS:	All
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:		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-08-03 13:09:25 UTC

This section doesn't correctly use markups.

Real values (like interface names) appear in , which is confusing because readers could copy/paste them and think they are part of the command.

For example, if you use a placeholder, it should use the following markups/notation
ip link add name __ ...

If you use real values, then don't use angle brackets.

For further details, see the RH SSG:
https://redhat-documentation.github.io/supplementary-style-guide/#user-replaced-values

Reported by: mmuehlfe

https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/configuring_and_managing_networking/linux-traffic-control_configuring-and-managing-networking#annotations:a7a12809-463e-4260-8163-4b9b0d98d3ae

Comment 1 Marc Muehlfeld 2023-08-03 13:11:43 UTC

DDF broke my example:

> ip link add name __ ...

should be:

ip link add name __<interface_name>__ ...