Skip to content

Commit 23589e6

Browse files
julian-cablejulian-cable
authored
287 Add release notes (#343)
* 287 Add release notes * 287 Minor change to release wording
1 parent 6ddc9fe commit 23589e6

File tree

5 files changed

+83
-8
lines changed

5 files changed

+83
-8
lines changed

‎en-US/New.xml

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "Conventions_for_Writers_and_Editors.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<section id="new">
7+
<title>New in This Release</title>
8+
<formalpara id="new_51">
9+
<title>Release 5.1</title>
10+
<para>Minor update in January 2022 to address some reported issues:</para>
11+
</formalpara>
12+
<itemizedlist>
13+
<listitem>
14+
<para>Accessing IBM Style online.</para>
15+
</listitem>
16+
<listitem>
17+
<para>Updated guidance for long commands.</para>
18+
</listitem>
19+
<listitem>
20+
<para>Updated guidance for referring to object names.</para>
21+
</listitem>
22+
<listitem>
23+
<para>Updated guidance for non-breaking spaces.</para>
24+
</listitem>
25+
<listitem>
26+
<para>Updated guidance for punctuation with quotation marks.</para>
27+
</listitem>
28+
<listitem>
29+
<para>The gerund verb form is no longer required in section titles.</para>
30+
</listitem>
31+
<listitem>
32+
<para>Pronouncing file or directory names that begin with special characters.</para>
33+
</listitem>
34+
<listitem>
35+
<para>Avoid "the product allows the user to do xyz".</para>
36+
</listitem>
37+
<listitem>
38+
<para>Avoid consecutive headings.</para>
39+
</listitem>
40+
<listitem>
41+
<para>Guidance to refer to UI elements and to other publication titles.</para>
42+
</listitem>
43+
<listitem>
44+
<para>Clarification that diagram labels use sentence case.</para>
45+
</listitem>
46+
<listitem>
47+
<para>New or updated usage entries: backend, IaC, number sign, on premise/on-premise, prebaked, unset.</para>
48+
</listitem>
49+
</itemizedlist>
50+
51+
<formalpara id="new_50">
52+
<title>Release 5.0</title>
53+
<para>Major update in July 2021 to align with some recent changes in IBM Style:</para>
54+
</formalpara>
55+
<itemizedlist>
56+
<listitem>
57+
<para>Sentence case is required for captions, legends, and diagram labels.</para>
58+
</listitem>
59+
<listitem>
60+
<para>Punctuation: Added sections on referring to punctuation marks and names of punctuation marks and special characters.</para>
61+
</listitem>
62+
<listitem>
63+
<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>
64+
</listitem>
65+
<listitem>
66+
<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>
67+
</listitem>
68+
<listitem>
69+
<para>Minor edits so the guide itself conforms with its own advice.</para>
70+
</listitem>
71+
</itemizedlist>
72+
</section>

‎en-US/O.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@
111111

112112
<!-- Advice differs from IBM Style, which says to use "on premises", "on-premises". -->
113113
<varlistentry id="onpremise">
114-
<term>on premise</term>
114+
<term>on premise, on-premise</term>
115115
<listitem>
116116
<para>
117117
<emphasis>adverb</emphasis>

‎en-US/Preface.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
]>
66
<preface id="pref-preface">
77
<title>Preface</title>
8+
<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" />
9+
</xi:fallback>
10+
</xi:include>
811
<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" />
912
</xi:fallback>
1013
</xi:include>

‎en-US/Style_Conventions_for_Writers_and_Editors.ent

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!ENTITY PRODUCT "Red Hat Style Guide">
22
<!ENTITY BOOKID "Writing_Style_Guide">
3-
<!ENTITY YEAR "2021">
3+
<!ENTITY YEAR "2022">
44
<!ENTITY HOLDER "Red Hat, Inc">
5-
<!-- Change entity year to 2021 -->
5+
<!-- Change entity year to 2022 -->

‎en-US/Style_Conventions_for_Writers_and_Editors.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,15 @@
5959
<!-- <xi:include href="WUG_References.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
6060
<!-- <xi:include href="WUG_Intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
6161
</part>
62-
<part id="part-Revision_History" label="III">
62+
<!-- <part id="part-Revision_History" label="III">
6363
<title>Revision History</title>
64-
<partintro>
64+
<partintro>
6565
<para>
66-
Make the release notes for the style guide available on stylepedia.net:
66+
Make the release notes for the style guide available on stylepedia.net:
6767
</para>
6868
</partintro>
69-
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
70-
</part>
69+
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
70+
</part> -->
7171

7272
<!-- <index /> -->
7373
</book>

0 commit comments

Comments
 (0)