Skip to content

Add release notes and update version info #564

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 26, 2024
Merged

Add release notes and update version info #564

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
4bd5d8c
Add release notes and update version info
julian-cable Feb 26, 2024
2b73147
Minor wording fix
julian-cable Feb 26, 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.1</edition>
<edition>6.2</edition>
<pubsnumber>1</pubsnumber>
<abstract>
<para>
Expand Down
63 changes: 61 additions & 2 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,66 @@
]>
<section id="new">
<title>New in This Release</title>
<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>
</formalpara>
<itemizedlist>
<listitem>
<para>Added guidance about line continuation for multiple operating systems.
Refer to <xref linkend="continuation"/>.</para>
</listitem>
<listitem>
<para>Various updates to guidance about punctuation, including in lists and in tables.
Refer to <xref linkend="punctuation"/>.</para>
</listitem>
<listitem>
<para>Updated guidance about referring to special characters.
Refer to <xref linkend="referring"/>.</para>
</listitem>
<listitem>
<para>You can use the possessive form of the company name (Red&nbsp;Hat's) to refer to the company itself, not to any products or services.
Refer to <xref linkend="possessives"/>.</para>
</listitem>
<listitem>
<para>Updated guidance about referring to named objects: usually as an adjective followed by a noun, but with some stated exceptions.
Refer to <xref linkend="refer-object-names"/>.</para>
</listitem>
<listitem>
<para>Updated guidance about using realistic usernames, and updated some of the username examples.
Refer to <xref linkend="using-realistic-names"/>.</para>
</listitem>
<listitem>
<para>Added some clarifications about writing titles, and about the use of titles and captions with tables and images.
Refer to <xref linkend="heading-styles"/>.</para>
</listitem>
<listitem>
<para>Added guidance about referring to Booleans.
Refer to <xref linkend="boolean"/>.</para>
</listitem>
<listitem>
<para>Use "refer to" instead of "see" for references.
Refer to <xref linkend="refer-to"/>.</para>
</listitem>
<listitem>
<para>Updated terms that relate to 64-bit architecture: 64-bit ARM, 64-bit x86, AArch64, aarch64, AMD64, amd64, ARM64, arm64, Intel 64, x86_64.
Refer to <xref linkend="part-Usage_Dictionary"/>.</para>
</listitem>
<listitem>
<para>Updated terms that relate to archive files: tar, tarball, untar, unzip, zip.
Refer to <xref linkend="part-Usage_Dictionary"/>.</para>
</listitem>
<listitem>
<para>New or updated usage entries: lookup, refer to, screenshot, see.
Refer to <xref linkend="part-Usage_Dictionary"/>.</para>
</listitem>
<listitem>
<para>Various other fixes.</para>
</listitem>

</itemizedlist>


<formalpara id="new_61">
<title>Release 6.1</title>
<para>Update in August 2023 to provide added or updated guidance and to address reported issues.
Expand Down Expand Up @@ -71,8 +131,7 @@
Refer to <xref linkend="squad"/>.</para>
</listitem>
<listitem>
<para>New or updated usage entries: application velocity, key ring, Metal-as-a-Service, OTP, smart card, systemwide, virtualized.
Refer to <xref linkend="part-Usage_Dictionary"/>.</para>
<para>Improved formatting of spacing after tables and of displaying footnotes in dark mode.</para>
</listitem>
<listitem>
<para>Various other fixes.</para>
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 "2023">
<!ENTITY YEAR "2024">
<!ENTITY HOLDER "Red Hat, Inc">
<!-- Change entity year to 2023 -->
<!-- Change entity year to 2024 -->
6 changes: 3 additions & 3 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@

<div>
<h3>
<a target="_self" href="https://stylepedia.net/style/6.1" style="text-decoration: underline;" title="The Red&nbsp;Hat Technical Writing Style Guide">
<img class="social" src="font/fontawesome/svgs/brands/readme.svg" alt="Style Guide" width="40em" /> Red&nbsp;Hat Technical Writing Style Guide v6.1</a>
<a target="_self" href="https://stylepedia.net/style/6.2" style="text-decoration: underline;" title="The Red&nbsp;Hat Technical Writing Style Guide">
<img class="social" src="font/fontawesome/svgs/brands/readme.svg" alt="Style Guide" width="40em" /> Red&nbsp;Hat Technical Writing Style Guide v6.2</a>
</h3>
<h3>
<a href="https://www.redhat.com/en/about/brand/standards" target="_blank" style="text-decoration: underline;">
Expand All @@ -66,7 +66,7 @@ <h3>
<footer>
<div>

<p>Copyright ©2023 Red Hat</p>
<p>Copyright ©2024 Red Hat</p>

<p>Powered by <strong>HTML5</strong></p>
</div>
Expand Down