Skip to content

Commit 11d61ab

Browse files
authored
Add release notes (#620)
* Add release notes * Apply feedback
1 parent 1c6d3f0 commit 11d61ab

File tree

2 files changed

+81
-1
lines changed

2 files changed

+81
-1
lines changed

en-US/Book_Info.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<!-- Change title to "The Red Hat Style Guide" -->
99
<productname>Red&nbsp;Hat Technical Writing Style&nbsp;Guide</productname>
1010
<productnumber></productnumber>
11-
<edition>6.2</edition>
11+
<edition>7.0</edition>
1212
<pubsnumber>1</pubsnumber>
1313
<abstract>
1414
<para>

en-US/New.xml

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,86 @@
55
]>
66
<section id="new">
77
<title>New in This Release</title>
8+
<formalpara id="new_70">
9+
<title>Release 7.0</title>
10+
<para>Major update in October 2024 with migration to a new hosting site, and extensive added and updated guidance.</para>
11+
</formalpara>
12+
<itemizedlist>
13+
<!-- <listitem>
14+
<para>This guide is now hosted at https://nnn.redhat.com and no longer at https://stylepedia.net/.</para>
15+
</listitem>
16+
<listitem>
17+
<para>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.</para>
18+
</listitem> -->
19+
<listitem>
20+
<para>Updated references to IBM Style to include a link, either to the guide or to a specific topic page where relevant.
21+
Each link is denoted with a padlock icon, to show that access is currently restricted to IBM and Red&nbsp;Hat employees.</para>
22+
</listitem>
23+
<listitem>
24+
<para>Removed content that was specific to marketing content.
25+
Removed references to AP Style.</para>
26+
</listitem>
27+
<listitem>
28+
<para>Updated the audience information.
29+
Refer to <xref linkend="audience"/>.</para>
30+
</listitem>
31+
<listitem>
32+
<para>Updated the resources information.
33+
Refer to <xref linkend="resources"/>.</para>
34+
</listitem>
35+
<listitem>
36+
<para>Updated guidance to use the simpler phrase "go to" rather than "navigate to", for directing readers to a location.
37+
Refer to <xref linkend="go-to"/> and <xref linkend="navigate-to"/>.</para>
38+
</listitem>
39+
<listitem>
40+
<para>Updated guidance on when to use "named" versus "called" to refer to different items.
41+
Refer to <xref linkend="named"/> and <xref linkend="called"/>.</para>
42+
</listitem>
43+
<listitem>
44+
<para>Added a definition of "mission-critical".
45+
Refer to <xref linkend="mission-critical"/>.</para>
46+
</listitem>
47+
<listitem>
48+
<para>Updated guidance for "command line", "command-line", "command prompt", "shell prompt", and "terminal".
49+
Refer to <xref linkend="command-line"/>, <xref linkend="shell-prompt"/>, and <xref linkend="terminal"/>.</para>
50+
</listitem>
51+
<listitem>
52+
<para>Other new or updated usage entries:
53+
dash, data store/datastore, dialog box, EPUB, hardened, Infrastructure as Code (IaC), lifecycle, secure, sign in/sign-in.
54+
Refer to <xref linkend="part-Usage_Dictionary"/>.</para>
55+
</listitem>
56+
<listitem>
57+
<para>Removed usage entries: check, emdash.</para>
58+
</listitem>
59+
<listitem>
60+
<para>Updated guidance on using "Overview" in a title.
61+
Refer to <xref linkend="overview"/>.</para>
62+
</listitem>
63+
<listitem>
64+
<para>Clarified the use of non-breaking spaces.
65+
Refer to <xref linkend="nonbreaking-spaces"/>.</para>
66+
</listitem>
67+
<listitem>
68+
<para>Added guidance on notation for omitting vertical output.
69+
Refer to <xref linkend="omitting"/>.</para>
70+
</listitem>
71+
<listitem>
72+
<para>Updated guidance on when to use compact spacing in lists.
73+
Refer to <xref linkend="Sentence_Structure-Using_Lists_Correctly"/>.</para>
74+
</listitem>
75+
<listitem>
76+
<para>Added the pipe character to the table of special characters.
77+
Refer to <xref linkend="punc-names"/>.</para>
78+
</listitem>
79+
<listitem>
80+
<para>Various other fixes.</para>
81+
</listitem>
82+
83+
84+
85+
86+
</itemizedlist>
87+
888
<formalpara id="new_62">
989
<title>Release 6.2</title>
1090
<para>Update in February 2024 to provide added or updated guidance and to address reported issues.</para>

0 commit comments

Comments
 (0)