From fbf98186239826fd9ed5063fafaf37a7ce565c56 Mon Sep 17 00:00:00 2001 From: julian-cable Date: Thu, 26 Sep 2024 19:30:24 +0100 Subject: [PATCH 1/2] Add release notes --- en-US/Book_Info.xml | 2 +- en-US/New.xml | 80 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 81 insertions(+), 1 deletion(-) diff --git a/en-US/Book_Info.xml b/en-US/Book_Info.xml index f499499..6371a85 100644 --- a/en-US/Book_Info.xml +++ b/en-US/Book_Info.xml @@ -8,7 +8,7 @@ Red Hat Technical Writing Style Guide - 6.2 + 7.0 1 diff --git a/en-US/New.xml b/en-US/New.xml index 0fdc21e..4d7fad8 100644 --- a/en-US/New.xml +++ b/en-US/New.xml @@ -5,6 +5,86 @@ ]>
New in This Release + + Release 7.0 + Major update in October 2024 with migration to a new hosting site, and extensive added and updated guidance. + + + + + Updated references to IBM Style to include a link, which is to a specific topic page where relevant. + Each link is denoted with a padlock icon, to show that access is currently restricted to IBM and Red Hat employees. + + + Removed content that was specific to marketing content. + Removed references to AP Style. + + + Updated the audience information. + Refer to . + + + Updated the resources information. + Refer to . + + + Updated guidance to use the simpler phrase "go to" rather than "navigate to", for directing readers to a location. + Refer to and . + + + Updated guidance on when to use "named" versus "called" to refer to different items. + Refer to and . + + + Added a definition of "mission-critical". + Refer to . + + + Updated guidance for "command line", "command-line", "command prompt", "shell prompt", and "terminal". + Refer to , , and . + + + Updated guidance on using "Overview" in a title. + Refer to . + + + Clarified the use of non-breaking spaces. + Refer to . + + + Added guidance on notation for omitting vertical output. + Refer to . + + + Updated guidance on when to use or not to use compact spacing in lists. + Refer to . + + + Added the pipe character to the table of special characters. + Refer to . + + + New or updated usage entries: + dash, data store/datastore, dialog box, EPUB, Infrastructure as Code (IaC), lifecycle, sign in/sign-in. + Refer to . + + + Removed usage entries: check, emdash. + + + Various other fixes. + + + + + + + Release 6.2 Update in February 2024 to provide added or updated guidance and to address reported issues. From 89d12ab4aac4ce98110bfe0610978b868fb344a7 Mon Sep 17 00:00:00 2001 From: julian-cable Date: Fri, 27 Sep 2024 14:39:53 +0100 Subject: [PATCH 2/2] Apply feedback --- en-US/New.xml | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/en-US/New.xml b/en-US/New.xml index 4d7fad8..8599bad 100644 --- a/en-US/New.xml +++ b/en-US/New.xml @@ -17,7 +17,7 @@ The GitHub repository for contributions to this guide is now at https://github.com/RedHatTraining/nnnnn and no longer at https://github.com/StyleGuides/WritingStyleGuide. --> - Updated references to IBM Style to include a link, which is to a specific topic page where relevant. + Updated references to IBM Style to include a link, either to the guide or to a specific topic page where relevant. Each link is denoted with a padlock icon, to show that access is currently restricted to IBM and Red Hat employees. @@ -48,6 +48,14 @@ Updated guidance for "command line", "command-line", "command prompt", "shell prompt", and "terminal". Refer to , , and . + + Other new or updated usage entries: + dash, data store/datastore, dialog box, EPUB, hardened, Infrastructure as Code (IaC), lifecycle, secure, sign in/sign-in. + Refer to . + + + Removed usage entries: check, emdash. + Updated guidance on using "Overview" in a title. Refer to . @@ -61,21 +69,13 @@ Refer to . - Updated guidance on when to use or not to use compact spacing in lists. + Updated guidance on when to use compact spacing in lists. Refer to . Added the pipe character to the table of special characters. Refer to . - - New or updated usage entries: - dash, data store/datastore, dialog box, EPUB, Infrastructure as Code (IaC), lifecycle, sign in/sign-in. - Refer to . - - - Removed usage entries: check, emdash. - Various other fixes.