Skip to content

Commit f1cb2a5

Browse files
authored
Add 'hardened', update 'secure', update omitted output (#621)
* Add 'hardened', update 'secure', update omitted output * Apply feedback
1 parent 11d61ab commit f1cb2a5

File tree

3 files changed

+42
-3
lines changed

3 files changed

+42
-3
lines changed

en-US/Design.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,7 @@ The ARN in the preceding output is different on your system.
529529
For the sake of brevity, do not show all output to the user in all cases, but only those parts of any output that are relevant to the context that is described.
530530
Where output is not included, place a marker to show that information is purposely excluded.
531531
When shortening the output, use a consistent notation.
532-
For omitting horizontal lines of output, Red&nbsp;Hat uses the <emphasis>...output&nbsp;omitted...</emphasis> notation, starting and ending with an ellipsis, and highlighted in italics.
532+
For omitting entire horizontal lines of output, Red&nbsp;Hat uses the <emphasis>...output&nbsp;omitted...</emphasis> notation, starting and ending with an ellipsis, and highlighted in italics.
533533
</para>
534534

535535
<example><title>Notation for Omitting Horizontal Output</title>
@@ -542,7 +542,7 @@ STEP 14: COMMIT <emphasis>...output omitted...</emphasis> localhost/nexus:latest
542542
</example>
543543

544544
<para>
545-
For omitting vertical columns of output, use a consistent notation such as an ellipsis (...).
545+
For omitting vertical columns of output, omitting partial lines of output, or to shorten long strings in output, Red&nbsp;Hat uses the ellipsis notation (...).
546546
</para>
547547

548548
<example><title>Notation for Omitting Vertical Output</title>

en-US/H.xml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,19 @@
5252

5353
</listitem>
5454

55+
</varlistentry>
56+
<varlistentry id="hardened">
57+
<term>hardened</term>
58+
<listitem>
59+
<para>
60+
<emphasis>adj.</emphasis> Do not use as a general descriptor for Red&nbsp;Hat's software development model or to describe the value of a Red&nbsp;Hat subscription.
61+
Use this term in the context of security, for example, reducing the attack surface by enhancing code and fixing vulnerabilities.
62+
If this term is used in other contexts, then add a qualifier.
63+
Always add a descriptive phrase to explain: for example, "hardened for security" or "hardened for stability".
64+
</para>
65+
66+
</listitem>
67+
5568
</varlistentry>
5669
<varlistentry id="he-she">
5770
<term>he/she</term>

en-US/S.xml

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,32 @@
8181
<term>secure</term>
8282
<listitem>
8383
<para>
84+
Instead of stating that a product or service is "secure", describe specifically how features or qualities provide trustworthiness and resilience, and provide verifiable data where it exists.
85+
When discussing security, use qualifiers to avoid making definitive or unsubstantiated claims about security.
86+
</para>
87+
<table><title></title>
88+
<tgroup cols="2" align="left" colsep="1" rowsep="1">
89+
<colspec colname="c1" colnum="1" colwidth="1.0*"/>
90+
<colspec colname="c2" colnum="2" colwidth="2.0*"/>
91+
<thead>
92+
<row>
93+
<entry>Original text</entry>
94+
<entry>Improvement</entry>
95+
</row>
96+
</thead>
97+
<tbody>
98+
<row>
99+
<entry>This [product or solution] is secure.</entry>
100+
<entry>This [product or solution] enables you to [do X, Y, and Z] to improve security, by ...</entry>
101+
</row>
102+
<row>
103+
<entry>This [product or solution] is more secure.</entry>
104+
<entry>This [product or solution] is more secure through [describe the steps that are taken]; or This [product or solution] is more secure than [previous state, or competitor example with cited source].</entry>
105+
</row>
106+
</tbody>
107+
</tgroup>
108+
</table>
109+
<!-- <para>
84110
<emphasis>n., vb.</emphasis> Due to potential legal ramifications, do not use without a qualifier.
85111
Refer to <xref linkend="qualify-sensitive-terms"/> for examples.
86112
</para>
@@ -109,7 +135,7 @@
109135
</row>
110136
</tbody>
111137
</tgroup>
112-
</table>
138+
</table> -->
113139
</listitem>
114140
</varlistentry>
115141
<varlistentry id="see">

0 commit comments

Comments
 (0)