From 878765ba6498eaed90c5274922c841ab87b97f90 Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Mon, 14 Aug 2023 16:53:55 -0400 Subject: [PATCH 01/10] feat: added section about posessives --- en-US/Grammar.xml | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/en-US/Grammar.xml b/en-US/Grammar.xml index 3e66655..4250da5 100644 --- a/en-US/Grammar.xml +++ b/en-US/Grammar.xml @@ -146,6 +146,29 @@ +
+ Possessives + + Possessives are when singular and plural nouns have an appostrophe and s (these two components appear after a singular noun whereas the appostrophe comes after the letter s in a plural noun) to show that something or someone belongs to a person or thing. However, consider avoidng using these terms in the following scenario. + +
+ Abbreviations and Product Names + +Avoid using possessives to refer to abbreviations and product names + + + Examples: + + + + + GitHub is the place where the Red Hat Writing Style Guide is hosted. + + The OpenSauced Chrome Extension is the best tool to display your open source contributions. + + +
Using Who, Whom, That, and Which Correctly @@ -285,7 +308,6 @@ -
Sentence Structure From 95650a162a82d9dd9537adfd23c4d27b36cc8d4f Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Mon, 14 Aug 2023 16:54:18 -0400 Subject: [PATCH 02/10] feat: here's the actual section --- en-US/Grammar.xml | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/en-US/Grammar.xml b/en-US/Grammar.xml index 4250da5..ee9edff 100644 --- a/en-US/Grammar.xml +++ b/en-US/Grammar.xml @@ -162,12 +162,27 @@ Avoid using possessives to refer to abbreviations and product names - GitHub is the place where the Red Hat Writing Style Guide is hosted. + You can find NASA documentation on GitHub. The OpenSauced Chrome Extension is the best tool to display your open source contributions. -
+
+ People and Inanimate Objects + Even though possessives can't be used with product names and abbreviations, they can be used with people and inanimate objects. + + Examples: + + + + + Eddie Jaoude's YouTube channel is the best source for learning how to use GitHub. + + The alt tag's text for the Pepsi logo is too short. + + +
Using Who, Whom, That, and Which Correctly From 1c076fb0b9884187e26df947a7f69dd1d18be030 Mon Sep 17 00:00:00 2001 From: Christine Belzie <105683440+CBID2@users.noreply.github.com> Date: Tue, 15 Aug 2023 08:24:45 -0400 Subject: [PATCH 03/10] fix: made some revisions --- en-US/Grammar.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en-US/Grammar.xml b/en-US/Grammar.xml index ee9edff..657ca74 100644 --- a/en-US/Grammar.xml +++ b/en-US/Grammar.xml @@ -170,14 +170,14 @@ Avoid using possessives to refer to abbreviations and product names
People and Inanimate Objects - Even though possessives can't be used with product names and abbreviations, they can be used with people and inanimate objects. + Even though possessives cannot be used with product names and abbreviations, they can be used with people and inanimate objects. Examples: - Eddie Jaoude's YouTube channel is the best source for learning how to use GitHub. + Eddie Jaoude's YouTube channel is one of the best sources for learning how to use GitHub. The alt tag's text for the Pepsi logo is too short. From 4d6027784381906c223e33e17161b4e23268d660 Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Tue, 15 Aug 2023 15:31:32 +0100 Subject: [PATCH 04/10] Content and formatting updates --- en-US/Design.xml | 5 +++ en-US/Grammar.xml | 84 +++++++++++++++++++++++++++++-------------- en-US/Punctuation.xml | 4 +++ 3 files changed, 67 insertions(+), 26 deletions(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index ceb68ec..7b3ebe7 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -1058,6 +1058,11 @@ STEP 14: COMMIT ...output omitted... localhost/nexus:latest + + Do not use possessives to refer to product names. + For examples and more information, see . + + Do not hyphenate or break a product name across lines. diff --git a/en-US/Grammar.xml b/en-US/Grammar.xml index 657ca74..3446ed0 100644 --- a/en-US/Grammar.xml +++ b/en-US/Grammar.xml @@ -146,43 +146,75 @@
-
- Possessives +
+ Possessives - Possessives are when singular and plural nouns have an appostrophe and s (these two components appear after a singular noun whereas the appostrophe comes after the letter s in a plural noun) to show that something or someone belongs to a person or thing. However, consider avoidng using these terms in the following scenario. + A possessive indicates that something or someone belongs to a person or thing. + -
- Abbreviations and Product Names - -Avoid using possessives to refer to abbreviations and product names - - + + For guidance on how to form a possessive, see . + + + Consider the following scenarios for when to use or not to use a possessive: + + + Do not use possessives to refer to abbreviations or product names. + + + + + + + + + + Example + Improvement + + + + + + + You can find NASA's documentation on GitHub. + You can find NASA documentation on GitHub. + + + + OpenSauced's Chrome Extension is a good tool to display your open source contributions. + The OpenSauced Chrome Extension is a good tool to display your open source contributions. + + + + Red Hat OpenShift's Logging operator creates cluster logging and cluster log forwarder instances. + The Red Hat OpenShift Logging operator creates cluster logging and cluster log forwarder instances. + + + + + + +
+ + + Otherwise, you can use possessives for people and inanimate objects. + + Examples: - + - You can find NASA documentation on GitHub. + Eddie Jaoude's YouTube channel is one of the best sources for learning how to use GitHub. - The OpenSauced Chrome Extension is the best tool to display your open source contributions. - -
-
- People and Inanimate Objects - Even though possessives cannot be used with product names and abbreviations, they can be used with people and inanimate objects. - - Examples: - - - - Eddie Jaoude's YouTube channel is one of the best sources for learning how to use GitHub. + + The alt tag's text for the Pepsi logo is too short. - The alt tag's text for the Pepsi logo is too short. - -
+
Using Who, Whom, That, and Which Correctly diff --git a/en-US/Punctuation.xml b/en-US/Punctuation.xml index fb58491..1a10c72 100644 --- a/en-US/Punctuation.xml +++ b/en-US/Punctuation.xml @@ -610,6 +610,10 @@ PLAY [Gather and display facts for managed nodes] **************************** Singular proper names ending in s only need an apostrophe (for example, Dickens' novels). + + For guidance on when to use or not to use a possessive, see . + +
From 1f5e5c10fc8f9afc6b6d426bcd0897e9de1cee24 Mon Sep 17 00:00:00 2001 From: Christine Belzie <105683440+CBID2@users.noreply.github.com> Date: Tue, 15 Aug 2023 11:51:16 -0400 Subject: [PATCH 05/10] Update en-US/Punctuation.xml Co-authored-by: Rachel Lee <131199744+rclee33@users.noreply.github.com> --- en-US/Punctuation.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en-US/Punctuation.xml b/en-US/Punctuation.xml index 1a10c72..bb65489 100644 --- a/en-US/Punctuation.xml +++ b/en-US/Punctuation.xml @@ -611,7 +611,7 @@ PLAY [Gather and display facts for managed nodes] ****************************s only need an apostrophe (for example, Dickens' novels). - For guidance on when to use or not to use a possessive, see . + For guidance on whether to use a possessive, see . From e1129288fffb89c540f535b3335c689b23b9d07a Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Tue, 15 Aug 2023 13:20:41 -0400 Subject: [PATCH 06/10] fix: made some revisions --- en-US/Design.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index 7b3ebe7..17f1908 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -1043,7 +1043,7 @@ STEP 14: COMMIT ...output omitted... localhost/nexus:latest Do not include "Inc." when referring to Red Hat except in legal documents. - + Do not use possessives with the Red Hat company name. For examples and more information, see [Section 3.7]() From 275d9b191aba6cd827b5fc796406cfdce78c9cb1 Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Tue, 15 Aug 2023 13:21:22 -0400 Subject: [PATCH 07/10] fix: made another revision --- en-US/Design.xml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index 17f1908..4612726 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -156,10 +156,6 @@ Click the ^ symbol. - - If you cannot easily reproduce the symbol, include a screen capture, or a succinct description of the object type, or both. - Use this approach for icons, especially when they have no tooltip or other help text. - Preferred Style for Documenting Icons Click the Upload ( @@ -1043,7 +1039,7 @@ STEP 14: COMMIT ...output omitted... localhost/nexus:latest Do not include "Inc." when referring to Red Hat except in legal documents. - Do not use possessives with the Red Hat company name. For examples and more information, see [Section 3.7]() + Do not use possessives with the Red Hat company name. For examples and more information, see [Section 3.7](https://stylepedia.net/style/6.0/#product-names) From 07af9aa2624994cdea11e5d3063cc311228190e4 Mon Sep 17 00:00:00 2001 From: Rachel Lee <131199744+rclee33@users.noreply.github.com> Date: Tue, 15 Aug 2023 14:37:36 -0400 Subject: [PATCH 08/10] Removed company name and restructured section --- en-US/Design.xml | 2 +- en-US/Grammar.xml | 41 +++++++++++++++++++++++++++++++---------- 2 files changed, 32 insertions(+), 11 deletions(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index 4612726..3fdb3ff 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -1039,7 +1039,7 @@ STEP 14: COMMIT ...output omitted... localhost/nexus:latest Do not include "Inc." when referring to Red Hat except in legal documents. - Do not use possessives with the Red Hat company name. For examples and more information, see [Section 3.7](https://stylepedia.net/style/6.0/#product-names) + diff --git a/en-US/Grammar.xml b/en-US/Grammar.xml index 3446ed0..32e9d16 100644 --- a/en-US/Grammar.xml +++ b/en-US/Grammar.xml @@ -155,11 +155,8 @@ For guidance on how to form a possessive, see . - - Consider the following scenarios for when to use or not to use a possessive: - - Do not use possessives to refer to abbreviations or product names. + Do not use possessives with product names. @@ -177,26 +174,50 @@ - You can find NASA's documentation on GitHub. - You can find NASA documentation on GitHub. + Red Hat OpenShift's Logging operator creates cluster logging and cluster log forwarder instances. + The Red Hat OpenShift Logging operator creates cluster logging and cluster log forwarder instances. - + OpenSauced's Chrome Extension is a good tool to display your open source contributions. The OpenSauced Chrome Extension is a good tool to display your open source contributions. + + + + +
+ + + Do not use possessives with abbreviations. + + + + + + + - Red Hat OpenShift's Logging operator creates cluster logging and cluster log forwarder instances. - The Red Hat OpenShift Logging operator creates cluster logging and cluster log forwarder instances. + Example + Improvement - + + + + + + You can find NASA's documentation on GitHub. + You can find NASA documentation on GitHub. + +
+ Otherwise, you can use possessives for people and inanimate objects. From 476ed7d583ab6b27e9c8e4217950e953c07066e9 Mon Sep 17 00:00:00 2001 From: Rachel Lee <131199744+rclee33@users.noreply.github.com> Date: Tue, 15 Aug 2023 14:48:39 -0400 Subject: [PATCH 09/10] added link in section 3.6 --- en-US/Design.xml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/en-US/Design.xml b/en-US/Design.xml index 3fdb3ff..c7994c7 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -990,6 +990,14 @@ STEP 14: COMMIT ...output omitted... localhost/nexus:latest + + Possessives + + Do not use possessives with abbreviations. For examples and more information, see . + + + + Special Characters From c4c58d5d9562606707fb93d912198b523fb32dab Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Wed, 16 Aug 2023 09:12:27 +0100 Subject: [PATCH 10/10] Final XML fix --- en-US/Design.xml | 2 +- en-US/Grammar.xml | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index c7994c7..d1cf53d 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -990,7 +990,7 @@ STEP 14: COMMIT ...output omitted... localhost/nexus:latest - + Possessives Do not use possessives with abbreviations. For examples and more information, see . diff --git a/en-US/Grammar.xml b/en-US/Grammar.xml index 32e9d16..79bdd98 100644 --- a/en-US/Grammar.xml +++ b/en-US/Grammar.xml @@ -150,7 +150,6 @@ Possessives A possessive indicates that something or someone belongs to a person or thing. - For guidance on how to form a possessive, see . @@ -217,7 +216,6 @@ - Otherwise, you can use possessives for people and inanimate objects.