Skip to content

Add 'hardened', update 'secure', update omitted output #621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions en-US/Design.xml
Original file line number Diff line number Diff line change
Expand Up @@ -529,7 +529,7 @@ The ARN in the preceding output is different on your system.
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.
Where output is not included, place a marker to show that information is purposely excluded.
When shortening the output, use a consistent notation.
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.
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.
</para>

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

<para>
For omitting vertical columns of output, use a consistent notation such as an ellipsis (...).
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 (...).
</para>

<example><title>Notation for Omitting Vertical Output</title>
Expand Down
13 changes: 13 additions & 0 deletions en-US/H.xml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,19 @@

</listitem>

</varlistentry>
<varlistentry id="hardened">
<term>hardened</term>
<listitem>
<para>
<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.
Use this term in the context of security, for example, reducing the attack surface by enhancing code and fixing vulnerabilities.
If this term is used in other contexts, then add a qualifier.
Always add a descriptive phrase to explain: for example, "hardened for security" or "hardened for stability".
</para>

</listitem>

</varlistentry>
<varlistentry id="he-she">
<term>he/she</term>
Expand Down
28 changes: 27 additions & 1 deletion en-US/S.xml
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,32 @@
<term>secure</term>
<listitem>
<para>
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.
When discussing security, use qualifiers to avoid making definitive or unsubstantiated claims about security.
</para>
<table><title></title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colname="c1" colnum="1" colwidth="1.0*"/>
<colspec colname="c2" colnum="2" colwidth="2.0*"/>
<thead>
<row>
<entry>Original text</entry>
<entry>Improvement</entry>
</row>
</thead>
<tbody>
<row>
<entry>This [product or solution] is secure.</entry>
<entry>This [product or solution] enables you to [do X, Y, and Z] to improve security, by ...</entry>
</row>
<row>
<entry>This [product or solution] is more secure.</entry>
<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>
</row>
</tbody>
</tgroup>
</table>
<!-- <para>
<emphasis>n., vb.</emphasis> Due to potential legal ramifications, do not use without a qualifier.
Refer to <xref linkend="qualify-sensitive-terms"/> for examples.
</para>
Expand Down Expand Up @@ -109,7 +135,7 @@
</row>
</tbody>
</tgroup>
</table>
</table> -->
</listitem>
</varlistentry>
<varlistentry id="see">
Expand Down