Bug 2228871 - [DDF] This section doesn't correctly use markups.
Summary: [DDF] This section doesn't correctly use markups.
Keywords:
Status: NEW
Alias: None
Product: Red Hat Enterprise Linux 9
Classification: Red Hat
Component: Documentation
Version: unspecified
Hardware: All
OS: All
medium
unspecified
Target Milestone: rc
: ---
Assignee: Mayur Patil
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-08-03 13:09 UTC by Direct Docs Feedback
Modified: 2023-08-03 14:32 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Type: ---
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHELPLAN-164372 0 None None None 2023-08-03 13:12:28 UTC

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>__ ...


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