From a17c38b0c9c40e9388e52d3396f0961e2f1a05c2 Mon Sep 17 00:00:00 2001 From: julian-cable Date: Wed, 2 Oct 2024 14:30:14 +0100 Subject: [PATCH 1/2] Add 'hardened', update 'secure', update omitted output --- en-US/Design.xml | 4 ++-- en-US/H.xml | 13 +++++++++++++ en-US/S.xml | 28 +++++++++++++++++++++++++++- 3 files changed, 42 insertions(+), 3 deletions(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index ae9c7c9..6e28790 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -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 Hat uses the ...output omitted... notation, starting and ending with an ellipsis, and highlighted in italics. + For omitting entire horizontal lines of output, Red Hat uses the ...output omitted... notation, starting and ending with an ellipsis, and highlighted in italics. Notation for Omitting Horizontal Output @@ -542,7 +542,7 @@ STEP 14: COMMIT ...output omitted... localhost/nexus:latest - For omitting vertical columns of output, use a consistent notation such as an ellipsis (...). + For omitting vertical columns of output, or omitting part of horizontal lines of output, Red Hat uses the ellipsis notation (...). Notation for Omitting Vertical Output diff --git a/en-US/H.xml b/en-US/H.xml index 72342da..f3562d2 100644 --- a/en-US/H.xml +++ b/en-US/H.xml @@ -52,6 +52,19 @@ + + + hardened + + + adj. Do not use as a general descriptor for Red Hat's software development model or to describe the value of a Red 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". + + + + he/she diff --git a/en-US/S.xml b/en-US/S.xml index 1b40ac8..efbdb1f 100644 --- a/en-US/S.xml +++ b/en-US/S.xml @@ -81,6 +81,32 @@ secure + 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. + Avoid exaggerated, misleading, or unsubstantiated claims about security. + + + + + + + + Original text + Improvement + + + + + This [product or solution] is secure. + This [product or solution] enables you to [do X, Y, and Z] to improve security, by ... + + + This [product or solution] is more secure. + 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]. + + + +
+ From 0c137128fe50d2ea9a10606e0abe0c739b625d11 Mon Sep 17 00:00:00 2001 From: julian-cable Date: Thu, 3 Oct 2024 14:17:32 +0100 Subject: [PATCH 2/2] Apply feedback --- en-US/Design.xml | 2 +- en-US/S.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index 6e28790..d56e377 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -542,7 +542,7 @@ STEP 14: COMMIT ...output omitted... localhost/nexus:latest - For omitting vertical columns of output, or omitting part of horizontal lines of output, Red Hat uses the ellipsis notation (...). + For omitting vertical columns of output, omitting partial lines of output, or to shorten long strings in output, Red Hat uses the ellipsis notation (...). Notation for Omitting Vertical Output diff --git a/en-US/S.xml b/en-US/S.xml index efbdb1f..fc87234 100644 --- a/en-US/S.xml +++ b/en-US/S.xml @@ -82,7 +82,7 @@ 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. - Avoid exaggerated, misleading, or unsubstantiated claims about security. + When discussing security, use qualifiers to avoid making definitive or unsubstantiated claims about security.