Skip to content

Implement suggestions from Ashley D'Andrea #589

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.

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
merged 3 commits into from
Jul 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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_Design.xml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
<section id="prefaces">
<title>Prefaces</title>
<para>
The brands that form part of Publican contain a preface as part of the common content. Whether your publication is for external Red&nbsp;Hat customers, JBoss customers, internal customers, or whomever, the brand you choose should provide a suitable preface. Try to use the standard preface to help maintain consistency, reduce overhead and maintenance, and also to reduce translation costs. If you feel that the preface fails to meet your needs, consider whether or not you are using the correct brand, or if the brand itself requires an update.
The brands that form part of Publican (<ulink url="https://fedorahosted.org/publican/" />) contain a preface as part of the common content. Whether your publication is for external Red&nbsp;Hat customers, JBoss customers, internal customers, or whomever, the brand you choose should provide a suitable preface. Try to use the standard preface to help maintain consistency, reduce overhead and maintenance, and also to reduce translation costs. If you feel that the preface fails to meet your needs, consider whether or not you are using the correct brand, or if the brand itself requires an update.
</para>

</section>
Expand Down
6 changes: 3 additions & 3 deletions en-US/C.xml
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
Do not use "characters" to mean "bytes". In English, bytes and characters can be used interchangeably; in other languages, a single character might consist of multiple bytes.
</para>
<para>
In computer software, any symbol that requires one byte of storage. This includes all the ASCII and extended ASCII characters, including the space character. In character-based software, everything that appears on the screen, including graphics symbols, is considered to be a character. In graphics-based applications, the term character is generally reserved for letters, numbers, and punctuation.
In computer software, a character is a symbol, such as a letter or number, that represents information. This includes all the ASCII and extended ASCII characters, including the space character. In character-based software, everything that appears on the screen, including graphics symbols, is considered to be a character. In graphics-based applications, the term character is generally reserved for letters, numbers, and punctuation.
</para>

</listitem>
Expand Down Expand Up @@ -443,8 +443,8 @@
<term>cookie</term>
<listitem>
<para>
<emphasis>n.</emphasis> A message given to a web browser by a web server.
The browser stores the message in a text file named <filename>cookie.txt</filename>.
<emphasis>n.</emphasis> Data that is given to a web browser by a web server.
The browser stores the message in a text file that might be named <filename>cookie.txt</filename>.
The message is then sent back to the server each time the browser requests a page from the server.
</para>

Expand Down
4 changes: 2 additions & 2 deletions en-US/Design.xml
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ STEP 14: COMMIT <emphasis>...output omitted...</emphasis> localhost/nexus:latest
</listitem>
<listitem>
<para>
As much as possible, leave the systemwide default as <varname>become: false</varname> or <varname>become: no</varname> and if a single task needs privileges, set <varname>become: true</varname> or <varname>become: yes</varname> on that task.
As much as possible, leave the system-wide default as <varname>become: false</varname> or <varname>become: no</varname> and if a single task needs privileges, set <varname>become: true</varname> or <varname>become: yes</varname> on that task.
</para>
</listitem>
<listitem>
Expand Down Expand Up @@ -1043,7 +1043,7 @@ STEP 14: COMMIT <emphasis>...output omitted...</emphasis> localhost/nexus:latest
<title>First Mentions</title>
<para>
Spell out most acronyms and initialisms before using them in text, such as "The Embedded DevKit (EDK) ...".
Unless required for the audience or the topic, do not spell out well-known abbreviations, such as HTML.
Unless required for the audience or the topic, do not spell out well-known initialisms, such as HTML.
</para>
</formalpara>

Expand Down
9 changes: 5 additions & 4 deletions en-US/G.xml
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,14 @@
<term>GB</term>
<listitem>
<para>
Abbreviation of gigabyte. Depending on the type of content you are writing, refer either to <citetitle>The AP Style Guide</citetitle> or the <citetitle>IBM Style Guide.</citetitle>
Abbreviation of gigabyte.
<!-- Depending on the type of content you are writing, refer either to <citetitle>The AP Style Guide</citetitle> or the <citetitle>IBM Style Guide.</citetitle> -->
</para>
<para>
<!-- <para>
AP style: Do not use a space between the value and the abbreviation. For example, "a 2GB file".
</para>
</para> -->
<para>
IBM style: Use a non-breaking space between the value and the abbreviation. For example, "a 2&nbsp;GB file".
Use a non-breaking space between the value and the abbreviation. For example, "a 2&nbsp;GB file".
</para>

</listitem>
Expand Down
2 changes: 1 addition & 1 deletion en-US/Grammar.xml
Original file line number Diff line number Diff line change
Expand Up @@ -972,7 +972,7 @@ Split contractions and abbreviations into separate paragraphs. -->
<formalpara id="hyphenate-complex-adjectives">
<title>Hyphenate Complex Adjectives</title>
<para>
Hyphenate complex adjectives (compound modifiers). This is when two adjectives work together to modify an object. The hyphen is used when the first adjective modifies the second adjective. For example, cloud-based solutions, right-side paralysis, systemwide menu.
Hyphenate complex adjectives (compound modifiers). This is when two adjectives work together to modify an object. The hyphen is used when the first adjective modifies the second adjective. For example, cloud-based solutions, right-side paralysis, system-wide menu.
</para>

</formalpara>
Expand Down
8 changes: 4 additions & 4 deletions en-US/Language.xml
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,7 @@
<term>low-hanging fruit</term>
<listitem>
<para>
Metaphor. Do not use.
Metaphor. Do not use. Instead, describe the outcome or opportunity in more precise terms, such as "readily achievable goals" or "low-risk, high-yield opportunities".
</para>

</listitem>
Expand Down Expand Up @@ -1168,7 +1168,7 @@
</row>
<row>
<entry> Kubernetes is an open source system that makes it easy to manage containerized applications across multiple hosts. </entry>
<entry> Kubernetes is an open source system to manage containerized applications across multiple hosts. </entry>
<entry> Kubernetes is an open source system that manages containerized applications across multiple hosts. </entry>

</row>

Expand Down Expand Up @@ -1238,8 +1238,8 @@
</thead>
<tbody>
<row>
<entry> Tab through the dialog box. Set the tab. Move the tab on the ruler. How to show or hide tabs. Select the tab. </entry>
<entry> Use the tab key to move through the dialog box. Set the tab stop. Move the tab mark on the ruler. How to show or hide tab characters. Select the <guimenuitem>View</guimenuitem> tab in the <guimenuitem>Options</guimenuitem> dialog box. </entry>
<entry> Tab through the dialog box. Set the tab. Move the tab on the ruler. How to show or hide tab characters. Select the tab. </entry>
<entry> Use the tab key to move through the dialog box. Set the tab stop. Move the tab mark on the ruler. To show or hide tab characters in Vim, use the <command>/\t</command> and <command>noh</command> commands. Select the <guimenuitem>View</guimenuitem> tab in the <guimenuitem>Options</guimenuitem> dialog box. </entry>

</row>
<row>
Expand Down
5 changes: 4 additions & 1 deletion en-US/S.xml
Original file line number Diff line number Diff line change
Expand Up @@ -652,7 +652,10 @@ a programming and technical sense, it also means "Run the <command>source</comma
<term>SSL</term>
<listitem>
<para>
Initialism for Secure Sockets Layer, a protocol developed by Netscape for transmitting private documents over the internet. SSL uses a public key to encrypt data that is transferred over the SSL connection. Most web browsers support SSL, and many websites use the protocol to obtain confidential user information, such as credit card numbers. By convention, URLs that require an SSL connection start with <emphasis>https:</emphasis> instead of <emphasis>http:</emphasis>.
Initialism for Secure Sockets Layer, a protocol developed by Netscape for transmitting private documents over the internet. SSL uses a public key to encrypt data that is transferred over the SSL connection. Most web browsers support SSL, and many websites use the protocol to obtain confidential user information, such as credit card numbers. By convention, URLs that require an SSL connection start with <emphasis>https:</emphasis> instead of <emphasis>http:</emphasis>. SSL later evolved into Transport Layer Security (TLS).
</para>
<para>
Refer also to <xref linkend="tls" />.
</para>

</listitem>
Expand Down
10 changes: 10 additions & 0 deletions en-US/T.xml
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,16 @@

</listitem>

</varlistentry>
<varlistentry id="tls">
<term>TLS</term>
<listitem>
<para>
Initialism for Transport Layer Security, a security protocol that provides privacy and data integrity for internet communications. By convention, URLs that require a TLS connection start with <emphasis>https:</emphasis> instead of <emphasis>http:</emphasis>.
</para>

</listitem>

</varlistentry>
<varlistentry id="token-ring">
<term>token-ring</term>
Expand Down
12 changes: 6 additions & 6 deletions en-US/Translation.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
<para>
These appear as numbered lists.
Use this list type for multiple entries if you need to refer to one of the entries from elsewhere in your document, or where order is important.
For example, if you need to list the order of operations that are required to prepare for an installation, or list a sequence of events that occurs.
For example, use an ordered list for a sequence of steps to complete a task, or for a sequence of events.
Titles are optional.
</para>
</listitem>
Expand Down Expand Up @@ -154,7 +154,7 @@
</para>
</entry>
<entry> <para>
Before you start the installation, follow these steps to ensure a smooth installation:
Before you start the installation, follow these prerequisite steps:
</para>
<itemizedlist>
<listitem>
Expand Down Expand Up @@ -625,13 +625,13 @@

</row>
<row>
<entry> Troubleshooting Glance. </entry>
<entry> Troubleshooting the Glance image service. </entry>
<entry> Troubleshoot Glance. </entry>
<entry> Troubleshoot the Glance image service. </entry>

</row>
<row>
<entry> Installing the <package>maven-changelog-plugin</package>. </entry>
<entry> Installing the <package>maven-changelog-plugin</package> package. </entry>
<entry> Install the <package>maven-changelog-plugin</package>. </entry>
<entry> Install the <package>maven-changelog-plugin</package> package. </entry>

</row>

Expand Down
4 changes: 2 additions & 2 deletions en-US/U.xml
Original file line number Diff line number Diff line change
Expand Up @@ -182,10 +182,10 @@

</varlistentry>
<varlistentry id="url">
<term>URL</term>
<term>URL, URI</term>
<listitem>
<para>
<emphasis>n.</emphasis> Include the appropriate protocol, such as http, ftp, or https, at the beginning of URLs. That is, use http://www.redhat.com and not www.redhat.com.
<emphasis>n.</emphasis> Include the appropriate scheme, such as http, ftp, or https, at the beginning of URLs or URIs. That is, use http://www.redhat.com and not www.redhat.com.
</para>
<para>
Refer to <xref linkend="other-websites" /> for more information.
Expand Down