Skip to content

287 Add release notes #343

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.

Sign up for GitHub

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
julian-cable merged 2 commits into from
Feb 2, 2022
Merged

287 Add release notes #343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb40bcf
287 Add release notes
julian-cable Feb 1, 2022
4c6ea37
287 Minor change to release wording
julian-cable Feb 2, 2022
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
72 changes: 72 additions & 0 deletions en-US/New.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Conventions_for_Writers_and_Editors.ent">
%BOOK_ENTITIES;
]>
<section id="new">
<title>New in This Release</title>
<formalpara id="new_51">
<title>Release 5.1</title>
<para>Minor update in January 2022 to address some reported issues:</para>
</formalpara>
<itemizedlist>
<listitem>
<para>Accessing IBM Style online.</para>
</listitem>
<listitem>
<para>Updated guidance for long commands.</para>
</listitem>
<listitem>
<para>Updated guidance for referring to object names.</para>
</listitem>
<listitem>
<para>Updated guidance for non-breaking spaces.</para>
</listitem>
<listitem>
<para>Updated guidance for punctuation with quotation marks.</para>
</listitem>
<listitem>
<para>The gerund verb form is no longer required in section titles.</para>
</listitem>
<listitem>
<para>Pronouncing file or directory names that begin with special characters.</para>
</listitem>
<listitem>
<para>Avoid "the product allows the user to do xyz".</para>
</listitem>
<listitem>
<para>Avoid consecutive headings.</para>
</listitem>
<listitem>
<para>Guidance to refer to UI elements and to other publication titles.</para>
</listitem>
<listitem>
<para>Clarification that diagram labels use sentence case.</para>
</listitem>
<listitem>
<para>New or updated usage entries: backend, IaC, number sign, on premise/on-premise, prebaked, unset.</para>
</listitem>
</itemizedlist>

<formalpara id="new_50">
<title>Release 5.0</title>
<para>Major update in July 2021 to align with some recent changes in IBM Style:</para>
</formalpara>
<itemizedlist>
<listitem>
<para>Sentence case is required for captions, legends, and diagram labels.</para>
</listitem>
<listitem>
<para>Punctuation: Added sections on referring to punctuation marks and names of punctuation marks and special characters.</para>
</listitem>
<listitem>
<para>Rename Chapter 4 to "Choosing Appropriate Language": expand scope beyond slang and jargon, to cover inclusive language; avoiding ambiguities (moved from Chapter 2 and added more categories); dates and times (AM and PM are now written in uppercase without periods); and numbers.</para>
</listitem>
<listitem>
<para>Usage A-Z: Various additions and updates. Corrected alphabetical sorting sequence. Moved items that are not literal term entries to an earlier chapter.</para>
</listitem>
<listitem>
<para>Minor edits so the guide itself conforms with its own advice.</para>
</listitem>
</itemizedlist>
</section>
2 changes: 1 addition & 1 deletion en-US/O.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@

<!-- Advice differs from IBM Style, which says to use "on premises", "on-premises". -->
<varlistentry id="onpremise">
<term>on premise</term>
<term>on premise, on-premise</term>
<listitem>
<para>
<emphasis>adverb</emphasis>
Expand Down
3 changes: 3 additions & 0 deletions en-US/Preface.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
]>
<preface id="pref-preface">
<title>Preface</title>
<xi:include href="New.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/New.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</xi:fallback>
</xi:include>
<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</xi:fallback>
</xi:include>
Expand Down
4 changes: 2 additions & 2 deletions en-US/Style_Conventions_for_Writers_and_Editors.ent
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!ENTITY PRODUCT "Red Hat Style Guide">
<!ENTITY BOOKID "Writing_Style_Guide">
<!ENTITY YEAR "2021">
<!ENTITY YEAR "2022">
<!ENTITY HOLDER "Red Hat, Inc">
<!-- Change entity year to 2021 -->
<!-- Change entity year to 2022 -->
10 changes: 5 additions & 5 deletions en-US/Style_Conventions_for_Writers_and_Editors.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,15 @@
<!-- <xi:include href="WUG_References.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
<!-- <xi:include href="WUG_Intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
</part>
<part id="part-Revision_History" label="III">
<!-- <part id="part-Revision_History" label="III">
<title>Revision History</title>
<partintro>
<partintro>
<para>
Make the release notes for the style guide available on stylepedia.net:
Make the release notes for the style guide available on stylepedia.net:
</para>
</partintro>
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</part>
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</part> -->

<!-- <index /> -->
</book>
Expand Down