Skip to content

Added release notes for 6.1 and updated version information #522

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 1 commit into from
Aug 22, 2023
Merged

Added release notes for 6.1 and updated version information #522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions en-US/Book_Info.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
<!-- Change title to "The Red Hat Style Guide" -->
<productname>Red&nbsp;Hat Technical Writing Style&nbsp;Guide</productname>
<productnumber></productnumber>
<edition>6.0</edition>
<edition>6.1</edition>
<pubsnumber>1</pubsnumber>
<abstract>
<para>
The Red&nbsp;Hat Style Guide and Word Usage Dictionary is a joint effort by various groups within Red&nbsp;Hat. It is intended as a supplement to the titles listed in <xref linkend="resources" />
The Red&nbsp;Hat Technical Writing Style Guide and Word Usage Dictionary is a joint effort by various groups within Red&nbsp;Hat. It is intended as a supplement to the titles listed in <xref linkend="resources" />
</para>

</abstract>
Expand Down
4 changes: 2 additions & 2 deletions en-US/Design.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@
</para>

</warning>
<section>
<section id="continuation">
<title>Documenting Multiple or Long Commands</title>
<note>
<para>
Expand Down Expand Up @@ -475,7 +475,7 @@ $ vi myFile.txt

</section>

<section>
<section id="omitting">
<title>Omitting Part of Output</title>
<para>
For the sake of brevity, do not show all output to the user in all cases, but only those parts of any output that are relevant to the context that is described.
Expand Down
76 changes: 75 additions & 1 deletion en-US/New.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,81 @@
]>
<section id="new">
<title>New in This Release</title>
<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.
The listed items here now include links to the appropriate sections.</para>
</formalpara>
<itemizedlist>
<listitem>
<para>Updated audience information for this guide.
See <xref linkend="audience"/>.</para>
</listitem>
<listitem>
<para>Updated guidance about writing titles.
See <xref linkend="verbs-titles"/>.</para>
</listitem>
<listitem>
<para>Updated guidance on continuation prompts.
See <xref linkend="continuation"/>.</para>
</listitem>
<listitem>
<para>Updated using realistic usernames.
See <xref linkend="using-realistic-names"/>.</para>
</listitem>
<listitem>
<para>Added guidance on omitting part of an output.
See <xref linkend="omitting"/>.</para>
</listitem>
<listitem>
<para>Added guidance about possessives with product names and abbreviations.
See <xref linkend="possessives"/>.</para>
</listitem>
<listitem>
<para>Various additions to the Punctuation section.
See <xref linkend="punctuation"/>.</para>
</listitem>
<listitem>
<para>Restructured "Using Abbreviations, Acronyms, Initialisms, and Special Characters Correctly".
See <xref linkend="abbreviations-correctly"/>.</para>
</listitem>
<listitem>
<para>Rewrote "The Repeatability Test" section and renamed it to "Repetition".
See <xref linkend="repeatability-test"/>.</para>
</listitem>
<listitem>
<para>Changed "Homographic Verbs" subsection title to "Avoid May and Should".
See <xref linkend="homographs"/>.</para>
</listitem>
<listitem>
<para>Inclusive naming of default branch.
See <xref linkend="inclusive-language"/>.</para>
</listitem>
<listitem>
<para>Updated IBM Style access information.
See <xref linkend="tech-content-refs"/>.</para>
</listitem>
<listitem>
<para>Adjusted sentence length guideline.
See <xref linkend="length"/>.</para>
</listitem>
<listitem>
<para>Removed some references that were specific to DocBook.</para>
</listitem>
<listitem>
<para>Use "team" or "group" instead of "squad".
See <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.
See <xref linkend="part-Usage_Dictionary"/>.</para>
</listitem>
<listitem>
<para>Various other fixes.</para>
</listitem>

</itemizedlist>

<formalpara id="new_60">
<title>Release 6.0</title>
<para>Major update in December 2022 to add further style and grammar guidance:</para>
Expand Down Expand Up @@ -109,7 +184,6 @@

</itemizedlist>


<formalpara id="new_51">
<title>Release 5.1</title>
<para>Minor update in January 2022 to address some reported issues:</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 "2022">
<!ENTITY YEAR "2023">
<!ENTITY HOLDER "Red Hat, Inc">
<!-- Change entity year to 2022 -->
<!-- Change entity year to 2023 -->