Skip to content

Commit 9b08622

Browse files
authored
Implement suggestions from Ashley D'Andrea (#589)
* Implement suggestions from Ashley D'Andrea * Apply feedback from Rachel * Apply feedback from Ashley
1 parent c43737e commit 9b08622

File tree

10 files changed

+38
-24
lines changed

10 files changed

+38
-24
lines changed

en-US/Book_Design.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
<section id="prefaces">
6565
<title>Prefaces</title>
6666
<para>
67-
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.
67+
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.
6868
</para>
6969

7070
</section>

en-US/C.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595
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.
9696
</para>
9797
<para>
98-
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.
98+
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.
9999
</para>
100100

101101
</listitem>
@@ -443,8 +443,8 @@
443443
<term>cookie</term>
444444
<listitem>
445445
<para>
446-
<emphasis>n.</emphasis> A message given to a web browser by a web server.
447-
The browser stores the message in a text file named <filename>cookie.txt</filename>.
446+
<emphasis>n.</emphasis> Data that is given to a web browser by a web server.
447+
The browser stores the message in a text file that might be named <filename>cookie.txt</filename>.
448448
The message is then sent back to the server each time the browser requests a page from the server.
449449
</para>
450450

en-US/Design.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,7 @@ STEP 14: COMMIT <emphasis>...output omitted...</emphasis> localhost/nexus:latest
637637
</listitem>
638638
<listitem>
639639
<para>
640-
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.
640+
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.
641641
</para>
642642
</listitem>
643643
<listitem>
@@ -1043,7 +1043,7 @@ STEP 14: COMMIT <emphasis>...output omitted...</emphasis> localhost/nexus:latest
10431043
<title>First Mentions</title>
10441044
<para>
10451045
Spell out most acronyms and initialisms before using them in text, such as "The Embedded DevKit (EDK) ...".
1046-
Unless required for the audience or the topic, do not spell out well-known abbreviations, such as HTML.
1046+
Unless required for the audience or the topic, do not spell out well-known initialisms, such as HTML.
10471047
</para>
10481048
</formalpara>
10491049

en-US/G.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,14 @@
3030
<term>GB</term>
3131
<listitem>
3232
<para>
33-
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>
33+
Abbreviation of gigabyte.
34+
<!-- 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> -->
3435
</para>
35-
<para>
36+
<!-- <para>
3637
AP style: Do not use a space between the value and the abbreviation. For example, "a 2GB file".
37-
</para>
38+
</para> -->
3839
<para>
39-
IBM style: Use a non-breaking space between the value and the abbreviation. For example, "a 2&nbsp;GB file".
40+
Use a non-breaking space between the value and the abbreviation. For example, "a 2&nbsp;GB file".
4041
</para>
4142

4243
</listitem>

en-US/Grammar.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -972,7 +972,7 @@ Split contractions and abbreviations into separate paragraphs. -->
972972
<formalpara id="hyphenate-complex-adjectives">
973973
<title>Hyphenate Complex Adjectives</title>
974974
<para>
975-
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.
975+
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.
976976
</para>
977977

978978
</formalpara>

en-US/Language.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@
527527
<term>low-hanging fruit</term>
528528
<listitem>
529529
<para>
530-
Metaphor. Do not use.
530+
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".
531531
</para>
532532

533533
</listitem>
@@ -1168,7 +1168,7 @@
11681168
</row>
11691169
<row>
11701170
<entry> Kubernetes is an open source system that makes it easy to manage containerized applications across multiple hosts. </entry>
1171-
<entry> Kubernetes is an open source system to manage containerized applications across multiple hosts. </entry>
1171+
<entry> Kubernetes is an open source system that manages containerized applications across multiple hosts. </entry>
11721172

11731173
</row>
11741174

@@ -1238,8 +1238,8 @@
12381238
</thead>
12391239
<tbody>
12401240
<row>
1241-
<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>
1242-
<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>
1241+
<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>
1242+
<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>
12431243

12441244
</row>
12451245
<row>

en-US/S.xml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -652,7 +652,10 @@ a programming and technical sense, it also means "Run the <command>source</comma
652652
<term>SSL</term>
653653
<listitem>
654654
<para>
655-
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>.
655+
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).
656+
</para>
657+
<para>
658+
Refer also to <xref linkend="tls" />.
656659
</para>
657660

658661
</listitem>

en-US/T.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,16 @@
187187

188188
</listitem>
189189

190+
</varlistentry>
191+
<varlistentry id="tls">
192+
<term>TLS</term>
193+
<listitem>
194+
<para>
195+
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>.
196+
</para>
197+
198+
</listitem>
199+
190200
</varlistentry>
191201
<varlistentry id="token-ring">
192202
<term>token-ring</term>

en-US/Translation.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
<para>
4343
These appear as numbered lists.
4444
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.
45-
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.
45+
For example, use an ordered list for a sequence of steps to complete a task, or for a sequence of events.
4646
Titles are optional.
4747
</para>
4848
</listitem>
@@ -154,7 +154,7 @@
154154
</para>
155155
</entry>
156156
<entry> <para>
157-
Before you start the installation, follow these steps to ensure a smooth installation:
157+
Before you start the installation, follow these prerequisite steps:
158158
</para>
159159
<itemizedlist>
160160
<listitem>
@@ -625,13 +625,13 @@
625625

626626
</row>
627627
<row>
628-
<entry> Troubleshooting Glance. </entry>
629-
<entry> Troubleshooting the Glance image service. </entry>
628+
<entry> Troubleshoot Glance. </entry>
629+
<entry> Troubleshoot the Glance image service. </entry>
630630

631631
</row>
632632
<row>
633-
<entry> Installing the <package>maven-changelog-plugin</package>. </entry>
634-
<entry> Installing the <package>maven-changelog-plugin</package> package. </entry>
633+
<entry> Install the <package>maven-changelog-plugin</package>. </entry>
634+
<entry> Install the <package>maven-changelog-plugin</package> package. </entry>
635635

636636
</row>
637637

en-US/U.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,10 +182,10 @@
182182

183183
</varlistentry>
184184
<varlistentry id="url">
185-
<term>URL</term>
185+
<term>URL, URI</term>
186186
<listitem>
187187
<para>
188-
<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.
188+
<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.
189189
</para>
190190
<para>
191191
Refer to <xref linkend="other-websites" /> for more information.

0 commit comments

Comments
 (0)