Skip to content

Add release notes #620

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
Sep 27, 2024
Merged

Add release notes #620

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
fbf9818
Add release notes
julian-cable Sep 26, 2024
89d12ab
Apply feedback
julian-cable Sep 27, 2024
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
2 changes: 1 addition & 1 deletion en-US/Book_Info.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<!-- Change title to "The Red Hat Style Guide" -->
<productname>Red&nbsp;Hat Technical Writing Style&nbsp;Guide</productname>
<productnumber></productnumber>
<edition>6.2</edition>
<edition>7.0</edition>
<pubsnumber>1</pubsnumber>
<abstract>
<para>
Expand Down
80 changes: 80 additions & 0 deletions en-US/New.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,86 @@
]>
<section id="new">
<title>New in This Release</title>
<formalpara id="new_70">
<title>Release 7.0</title>
<para>Major update in October 2024 with migration to a new hosting site, and extensive added and updated guidance.</para>
</formalpara>
<itemizedlist>
<!-- <listitem>
<para>This guide is now hosted at https://nnn.redhat.com and no longer at https://stylepedia.net/.</para>
</listitem>
<listitem>
<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>
</listitem> -->
<listitem>
<para>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&nbsp;Hat employees.</para>
</listitem>
<listitem>
<para>Removed content that was specific to marketing content.
Removed references to AP Style.</para>
</listitem>
<listitem>
<para>Updated the audience information.
Refer to <xref linkend="audience"/>.</para>
</listitem>
<listitem>
<para>Updated the resources information.
Refer to <xref linkend="resources"/>.</para>
</listitem>
<listitem>
<para>Updated guidance to use the simpler phrase "go to" rather than "navigate to", for directing readers to a location.
Copy link
Contributor

@rclee33 rclee33 Sep 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this list, what do you think about grouping all of the usage items together? There are quite a few items that relate to usage and definitions, and it might be useful for readers to keep them together in this list.

Refer to <xref linkend="go-to"/> and <xref linkend="navigate-to"/>.</para>
</listitem>
<listitem>
<para>Updated guidance on when to use "named" versus "called" to refer to different items.
Refer to <xref linkend="named"/> and <xref linkend="called"/>.</para>
</listitem>
<listitem>
<para>Added a definition of "mission-critical".
Refer to <xref linkend="mission-critical"/>.</para>
</listitem>
<listitem>
<para>Updated guidance for "command line", "command-line", "command prompt", "shell prompt", and "terminal".
Refer to <xref linkend="command-line"/>, <xref linkend="shell-prompt"/>, and <xref linkend="terminal"/>.</para>
</listitem>
<listitem>
<para>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 <xref linkend="part-Usage_Dictionary"/>.</para>
</listitem>
<listitem>
<para>Removed usage entries: check, emdash.</para>
</listitem>
<listitem>
<para>Updated guidance on using "Overview" in a title.
Refer to <xref linkend="overview"/>.</para>
</listitem>
<listitem>
<para>Clarified the use of non-breaking spaces.
Refer to <xref linkend="nonbreaking-spaces"/>.</para>
</listitem>
<listitem>
<para>Added guidance on notation for omitting vertical output.
Refer to <xref linkend="omitting"/>.</para>
</listitem>
<listitem>
<para>Updated guidance on when to use compact spacing in lists.
Refer to <xref linkend="Sentence_Structure-Using_Lists_Correctly"/>.</para>
</listitem>
<listitem>
<para>Added the pipe character to the table of special characters.
Copy link
Contributor

@rclee33 rclee33 Sep 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, nice addition! I never noticed that this character was missing!

Refer to <xref linkend="punc-names"/>.</para>
</listitem>
<listitem>
<para>Various other fixes.</para>
</listitem>




</itemizedlist>

<formalpara id="new_62">
<title>Release 6.2</title>
<para>Update in February 2024 to provide added or updated guidance and to address reported issues.</para>
Expand Down