From e7a43a7ffe351e4eaf2abbdbd5175652b3366995 Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Tue, 22 Aug 2023 11:10:05 +0100 Subject: [PATCH] Added release notes for 6.1 and updated version information --- en-US/Book_Info.xml | 4 +- en-US/Design.xml | 4 +- en-US/New.xml | 76 ++++++++++++++++++- ...le_Conventions_for_Writers_and_Editors.ent | 4 +- 4 files changed, 81 insertions(+), 7 deletions(-) diff --git a/en-US/Book_Info.xml b/en-US/Book_Info.xml index 163cbb2..e49ea58 100644 --- a/en-US/Book_Info.xml +++ b/en-US/Book_Info.xml @@ -8,11 +8,11 @@ Red Hat Technical Writing Style Guide - 6.0 + 6.1 1 - The Red Hat Style Guide and Word Usage Dictionary is a joint effort by various groups within Red Hat. It is intended as a supplement to the titles listed in + The Red Hat Technical Writing Style Guide and Word Usage Dictionary is a joint effort by various groups within Red Hat. It is intended as a supplement to the titles listed in diff --git a/en-US/Design.xml b/en-US/Design.xml index f9acd84..6414394 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -386,7 +386,7 @@ -
+
Documenting Multiple or Long Commands @@ -475,7 +475,7 @@ $ vi myFile.txt
-
+
Omitting Part of Output 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. diff --git a/en-US/New.xml b/en-US/New.xml index 61c8f8d..4f665e9 100644 --- a/en-US/New.xml +++ b/en-US/New.xml @@ -5,6 +5,81 @@ ]>
New in This Release + + Release 6.1 + Update in August 2023 to provide added or updated guidance and to address reported issues. + The listed items here now include links to the appropriate sections. + + + + Updated audience information for this guide. + See . + + + Updated guidance about writing titles. + See . + + + Updated guidance on continuation prompts. + See . + + + Updated using realistic usernames. + See . + + + Added guidance on omitting part of an output. + See . + + + Added guidance about possessives with product names and abbreviations. + See . + + + Various additions to the Punctuation section. + See . + + + Restructured "Using Abbreviations, Acronyms, Initialisms, and Special Characters Correctly". + See . + + + Rewrote "The Repeatability Test" section and renamed it to "Repetition". + See . + + + Changed "Homographic Verbs" subsection title to "Avoid May and Should". + See . + + + Inclusive naming of default branch. + See . + + + Updated IBM Style access information. + See . + + + Adjusted sentence length guideline. + See . + + + Removed some references that were specific to DocBook. + + + Use "team" or "group" instead of "squad". + See . + + + New or updated usage entries: application velocity, key ring, Metal-as-a-Service, OTP, smart card, systemwide, virtualized. + See . + + + Various other fixes. + + + + Release 6.0 Major update in December 2022 to add further style and grammar guidance: @@ -109,7 +184,6 @@ - Release 5.1 Minor update in January 2022 to address some reported issues: diff --git a/en-US/Style_Conventions_for_Writers_and_Editors.ent b/en-US/Style_Conventions_for_Writers_and_Editors.ent index a9587a6..c062671 100644 --- a/en-US/Style_Conventions_for_Writers_and_Editors.ent +++ b/en-US/Style_Conventions_for_Writers_and_Editors.ent @@ -1,5 +1,5 @@ - + - \ No newline at end of file + \ No newline at end of file