Skip to content

Relnotes #269

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
daobrien merged 4 commits into from
Aug 5, 2021
Merged

Relnotes #269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b628c63
Changed Times of day guidance.
Aug 4, 2021
f9dbf03
Added release notes in Markdown.
Aug 4, 2021
ecd28d7
Updated release notes.
Aug 5, 2021
81a5f7e
Times of day updates
Aug 5, 2021
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
14 changes: 3 additions & 11 deletions en-US/A.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,22 +94,14 @@

</varlistentry>
<varlistentry id="am">
<term role="true">a.m.</term>
<!-- <term role="false">am</term> -->
<term role="true">AM</term>
<listitem>
<para>
Use lowercase with periods, such as "11&nbsp;a.m.". Use a nonbreaking space between the numeral and "a.m.".
</para>
<!-- Not implementing this change yet.
<para>
Use uppercase without periods, and use a preceding nonbreaking space after the numeral, for example "11&nbsp;AM".
</para> -->
For times of day, use uppercase without periods, and use a preceding nonbreaking space after the numeral, for example "11&nbsp;AM".
</para>
<para>
See also <xref linkend="pm"/>.
</para>
<!-- <para>
See the <citetitle>IBM Style Guide</citetitle> for a full discussion of how to represent times.
</para> -->

</listitem>

Expand Down
16 changes: 7 additions & 9 deletions en-US/Language.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1265,25 +1265,23 @@ Numbers (move from N entry) -->
Exception: Use of an all-numeric representation is allowed when space is limited, as in a user interface, or to enhance readability. In such cases, use the ISO date format with a 4-digit year (YYYY-MM-DD) and define the format in a header or legend.
</para>
<para>
For times of day, use lowercase with periods, such as "11&nbsp;a.m.". Use a nonbreaking space between the numeral and "a.m." or "p.m.".
</para>
<!-- Not implementing this change yet.
<para>
For times of day, use uppercase without periods, such as "11&nbsp;AM". Use a nonbreaking space between the numeral and "AM" or "PM".
</para> -->
</para>

<para>
Use "noon" or "12 noon" instead of "12 p.m.".
Use "midnight" or "12 midnight" instead of "12 a.m.".
Use "noon" or "12 noon" instead of "12&nbsp;PM".
Use "midnight" or "12 midnight" instead of "12&nbsp;AM".
</para>
<itemizedlist>
<title>Examples</title>
<listitem>
<para>
The training class begins at 10 a.m. on 1 April 2021.
The training class begins at 10&nbsp;AM on 1 April 2021.
</para>
</listitem>
<listitem>
<para>
The coffee break is from 2:00 p.m. to 2:30 p.m.
The coffee break is from 2:00 PM to 2:30 PM.
</para>
</listitem>
</itemizedlist>
Expand Down
13 changes: 3 additions & 10 deletions en-US/P.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,21 +121,14 @@

</varlistentry>
<varlistentry id="pm">
<term role="true">p.m.</term>
<term role="true">PM</term>
<listitem>
<para>
Use lowercase with periods, such as "2&nbsp;p.m.". Use a nonbreaking space between the numeral and "p.m.".
</para>
<!-- Not implementing this change yet.
<para>
Use uppercase without periods, and use a preceding nonbreaking space after the numeral, for example "2&nbsp;PM".
</para> -->
For times of day, use uppercase without periods, and use a preceding nonbreaking space after the numeral, for example "2&nbsp;PM".
</para>
<para>
See also <xref linkend="am"/>.
</para>
<!-- <para>
See the <citetitle>IBM Style Guide</citetitle> for a full discussion of how to represent times.
</para> -->

</listitem>

Expand Down
25 changes: 25 additions & 0 deletions en-US/rel_notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Red Hat Style Guide: Version 5.0 Release Notes, July 2021

Changed guide title to “Red Hat Technical Writing Style Guide”. Changed subtitle to “Style Conventions for Writers and Editors”.

Added inclusive language guidance.

Added section on use of relative pronoun “that”.

Added sections on exclamation points and referring to punctuation marks.

Clarified that sentence case is required for captions, legends, and diagram labels.

Added section on phrasal verbs (two-word verb forms).

Added more categories of ambiguities to avoid.

Dates and Times: Changed times of day standard from “a.m.”, “p.m.” to “AM”, “PM”.

Usage A-Z added entries: appendixes, as long as, blacklist, colocate/colocation, display, following, i.e., indexes, login/log in/log in to, master, sign in/sign in to, slave, whitelist, wish

Updated entries: backwards-compatible, high-availability, hostname, lifecycle, OK, please, setup, username, ZIP Code

Removed guidance about DocBook and markup, to focus instead on writing.

Minor edits so the guide itself conforms more fully with its own advice.