Skip to content

Commit 4c54b6d

Browse files
julian-cabledaobriendaobrienmweetman-redhatCBID2
authored
Merge all updates from dev to master for 6.1 release (#523)
* Working on #450. * Run Vale over Design.xml. This is the end of part 1/4 of "Run Vale over the style guide." Too big a job to try to handle in one issue and PR. * Ongoing updates for #456 * Closes #456 Part 2 of running Vale over the style guide. I also addressed a few other issues along the way, such as one sentence per line and removing old comments. Language.xml in particular contains lots of examples of what not to do, so it produces lots of noise in Vale. * s/may/might/ per Julian's review. * Working on #457 Run Vale of the style guide part 3. * Closes #457 Run Vale over the style guide, part 3. * Remove spurious space. * Closes #458 Run Vale over style guide part 4. * Closes #365 Remove DocBook references. * Closes #78 Update entry for "virtualized". Basically copy/paste from corp guide. * Closes #355. Improve a bit of formatting. * feat: Add advice on naming the default branch in an inclusive way. (#493) * feat: Add advice on naming the default branch in an inclusive way. * Update en-US/Language.xml Co-authored-by: julian-cable <[email protected]> * Update en-US/Language.xml Co-authored-by: julian-cable <[email protected]> * Update en-US/Language.xml Co-authored-by: julian-cable <[email protected]> --------- Co-authored-by: julian-cable <[email protected]> * Updated section about writing titles (#492) * Updated section about writing titles * Reverted title ID * Further edits * Updated guidance on continuation prompts (#494) * Various fixes for 6.1 release (#495) * Various fixes for 6.1 release * XML fix * Updated IBM Style access info (#496) * Updated term entries (#497) * Added guidance on omitting part of an output (#500) * Added guidance on omitting part of an output * Updated wording * Typo fix * Updated sample names and other small fixes (#502) * Various fixes (#512) * Implementing various feedback suggestions from Rachel (#513) * Implementing various feedback suggestions from Rachel * Addressed review comments * Addressed further review comment * Added more punctuation guidance (#515) * Added more punctuation guidance * Implemented review feedback * Updated audience description (#518) * Updated audience description * Further updated audience wording * Adding information about posessives (#519) * feat: added section about posessives * feat: here's the actual section * fix: made some revisions * Content and formatting updates * Update en-US/Punctuation.xml Co-authored-by: Rachel Lee <[email protected]> * fix: made some revisions * fix: made another revision * Removed company name and restructured section * added link in section 3.6 * Final XML fix --------- Co-authored-by: Julian Cable <[email protected]> Co-authored-by: Rachel Lee <[email protected]> * Updated view and edit files section * Added release notes for 6.1 and updated version information (#522) * updating homepage (#525) --------- Co-authored-by: daobrien <[email protected]> Co-authored-by: David O'Brien <[email protected]> Co-authored-by: mweetman-redhat <[email protected]> Co-authored-by: Christine Belzie <[email protected]> Co-authored-by: Rachel Lee <[email protected]> Co-authored-by: Harpal Singh <[email protected]>
1 parent 4fc1c91 commit 4c54b6d

40 files changed

+1180
-533
lines changed

css/style.css

+4-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
}
1010

1111
body {
12-
font-family: 'overpass',sans;
12+
font-family: "liberation sans", "Myriad ", "Bitstream Vera Sans", "Lucida Grande", "Luxi Sans", "Trebuchet MS", helvetica, verdana, arial, sans-serif;
1313
background-color: #fff;
1414
margin: 0;
1515
padding: 0;
@@ -44,15 +44,16 @@ header img {
4444
}
4545

4646
#main > div {
47-
padding-top: 5%;
47+
padding-top: 2%;
4848
}
4949

5050
#main > img {
5151
padding-top: 5%;
5252
}
5353

5454
#main p {
55-
width: 50%;
55+
text-align: left;
56+
width: 70%;
5657
font-size: 1.33em;
5758
margin: auto;
5859
}

en-US/A.xml

+18-25
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@
55
]>
66
<chapter id="a">
77
<title>A</title>
8-
<!-- Some of the entries were not listed in alphabetical order. -->
98
<variablelist>
10-
<!-- Entries previously used a mixture of "v." and "vb." to denote a verb. Changed all occurrences to "v." -->
119
<varlistentry id="amp-and-">
1210
<term>"&amp;" and "+"</term>
1311
<listitem>
@@ -29,7 +27,6 @@
2927
</listitem>
3028

3129
</varlistentry>
32-
<!-- Removed "acronyms" entry (as it is not a literal term) and added this content instead to section 3.6. -->
3330

3431
<varlistentry id="agile-development">
3532
<term role="true">agile</term>
@@ -55,10 +52,10 @@
5552
</varlistentry>
5653
<varlistentry id="all-in-one">
5754
<term role="true">all-in-one</term>
58-
<term role="false">allinone</term>
5955
<listitem>
6056
<para>
61-
<emphasis>n., adj.</emphasis> Hyphenate in both places. Do not use "allinone" or other variations.
57+
<emphasis>n., adj.</emphasis> Write as shown as both a noun and an adjective.
58+
Do not use other variations.
6259
</para>
6360

6461
</listitem>
@@ -78,7 +75,7 @@
7875
</listitem>
7976

8077
</varlistentry>
81-
78+
8279
<varlistentry id="alternative">
8380
<term role="true">alternative</term>
8481
<listitem>
@@ -98,7 +95,7 @@
9895
<listitem>
9996
<para>
10097
For times of day, use uppercase without periods, and use a preceding nonbreaking space after the numeral, for example "11&nbsp;AM".
101-
</para>
98+
</para>
10299
<para>
103100
See also <xref linkend="pm"/>.
104101
</para>
@@ -123,7 +120,6 @@
123120
<para>
124121
The AMD64 logo is trademarked; the term "AMD64" is not. For more information about AMD trademarks, see the <citetitle>AMD Trademark Information</citetitle> page at <ulink url="https://www.amd.com/en/corporate/trademarks" />.
125122
</para>
126-
<!-- Updated URL for AMD trademarks. -->
127123
<para>
128124
For more information about Intel&reg; trademarks, see <ulink url="http://www.intel.com/content/www/us/en/legal/trademarks.html" /> and <ulink url="http://www.intel.com/content/www/us/en/trademarks/trademarks.html" />.
129125
</para>
@@ -147,7 +143,6 @@
147143

148144
</varlistentry>
149145

150-
<!-- Added "appendixes" entry. -->
151146
<varlistentry id="appendixes">
152147
<term>appendixes</term>
153148
<listitem>
@@ -157,27 +152,25 @@
157152

158153
</listitem>
159154

160-
</varlistentry>
155+
</varlistentry>
161156

162-
<!-- Commenting out this entry as it is not a literal term entry. Consider moving elsewhere, such as to Section 3.7 and expand scope of that section?
163-
<varlistentry id="application">
164-
<term>application</term>
157+
<varlistentry id="application-velocity">
158+
<term>application velocity</term>
165159
<listitem>
166160
<para>
167-
When used as a proper name, use the capitalization of the product, such as GNUPro, Source-Navigator, and Red&nbsp;Hat Enterprise&nbsp;Linux.
168-
When used as a command, use lowercase as appropriate, such as "To start GCC, type gcc".
161+
Used on its own, this phrase does not indicate what aspect of the application lifecycle is faster, because velocity means "speed in a given direction.”
162+
</para>
163+
<para>
164+
Always provide context on first mention for what exactly is moving faster (for example, application development velocity, development velocity, development and deployment velocity).
165+
Then, unless the meaning changes, you can use “application velocity” for subsequent uses.
166+
</para>
167+
<para>
168+
For example, the OpenShift team has used this term to mean "creating a streamlined developer experience" whose context is key to setting audience expectations for their content.
169169
</para>
170-
<note>
171-
<para>
172-
"vi" is always lowercase.
173-
</para>
174-
175-
</note>
176170

177171
</listitem>
178172

179173
</varlistentry>
180-
-->
181174

182175
<varlistentry id="applixware">
183176
<term role="true">Applixware</term>
@@ -263,7 +256,7 @@
263256
</listitem>
264257
<listitem>
265258
<para>
266-
MaaS (Messaging-as-a-Service)
259+
MaaS (Messaging-as-a-Service, Metal-as-a-Service)
267260
</para>
268261

269262
</listitem>
@@ -295,14 +288,14 @@
295288
<para>
296289
When in all capitals, such as a title or headline, the "aa" in the acronym remains lowercase (such as INTRODUCTION TO PaaS SOLUTIONS).
297290
</para>
298-
<!-- When would all capitals be used? -->
291+
<!-- When would all capitals be used? -->
299292

300293
</listitem>
301294
<listitem>
302295
<para>
303296
Hyphenate when written out: Thing-as-a-Service.
304297
For two-word prefixes, do not include a hyphen between the first and second words, for example: Mobile Backend-as-a-Service.
305-
It can be used as an adjective to describe multiple: for example, when referring to IaaS, PaaS, and SaaS, use as-a-Service offerings, as-a-Service products, or similar wording.
298+
It can be used as an adjective to describe multiple: for example, when referring to IaaS, MaaS, PaaS, and SaaS, use as-a-Service offerings, as-a-Service products, or similar wording.
306299
</para>
307300

308301
</listitem>

en-US/Audience.xml

+9-2
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,18 @@
66
<section id="audience">
77
<title>Audience</title>
88
<para>
9-
This guide is the official style guide for technical documentation for Red&nbsp;Hat training and certification content, including how to write for global audiences and translation, common mistakes to avoid, rules for everyday punctuation, and grammar.
9+
This guide is the official style guide for Red&nbsp;Hat training and certification content, and for all other technical documentation except as stated.
10+
Red&nbsp;Hat product documentation by Customer Content Services (CCS) follows the Red&nbsp;Hat supplementary style guide at <ulink url="https://redhat-documentation.github.io/supplementary-style-guide/" /> instead of this Red&nbsp;Hat Technical Writing Style Guide.
1011
</para>
1112
<para>
12-
Other Red&nbsp;Hat technical documentation, including product documentation by Customer Content Services (CCS), follows the Red&nbsp;Hat supplementary style guide for product documentation at <ulink url="https://redhat-documentation.github.io/supplementary-style-guide/" /> instead of this Red&nbsp;Hat Technical Writing Style Guide.
13+
The Red&nbsp;Hat Technical Writing Style Guide includes everyday punctuation and grammar, common mistakes to avoid, strategies for translation and global audiences, and a word usage dictionary.
1314
</para>
15+
<para>
16+
This guide is a public guide. It is reviewed and maintained by Red&nbsp;Hat. Contributions from the wider community are always welcomed.
17+
</para>
18+
<para>
19+
Other resources for technical writing are listed in <xref linkend="resources"/>.
20+
</para>
1421

1522
</section>
1623

en-US/Author_Group.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
]>
66
<authorgroup>
77
<author>
8-
<firstname>Red Hat Documentation Team</firstname>
8+
<firstname>Red&nbsp;Hat Documentation Team</firstname>
99
<surname></surname>
1010
<affiliation>
1111
<orgname></orgname>

en-US/B.xml

+3-4
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@
7575
<para>
7676
Do not use. Instead, use "compatible with earlier versions" to refer to something that is compatible with older equipment or previous versions of software. See also <xref linkend="forwards-compatible" />.
7777
</para>
78-
<!-- Replaced with "compatible with earlier versions", to align with advice for "forwards-compatible". -->
7978

8079
</listitem>
8180

@@ -362,8 +361,8 @@
362361
<term>broadcast</term>
363362
<listitem>
364363
<para>
365-
To send the same message simultaneously to multiple recipients. Broadcasting is a useful feature in email systems.
366-
<!-- Deleted reference to fax.
364+
To send the same message simultaneously to multiple recipients. Broadcasting is a useful feature in email systems.
365+
<!-- Deleted reference to fax.
367366
It is also supported by some fax systems. -->
368367
</para>
369368
<para>
@@ -383,7 +382,7 @@
383382
See <ulink url="http://en.wikipedia.org/wiki/Btrfs" /> for more information on this file system.
384383
</para>
385384
<para>
386-
See <ulink url="http://en.wikipedia.org/wiki/List_of_file_systems" /> for a list of file system names and how to present them.
385+
See <ulink url="http://en.wikipedia.org/wiki/List_of_file_systems" /> for a list of file-system names and how to present them.
387386
</para>
388387

389388
</listitem>

en-US/Book_Design.xml

+4-2
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,9 @@
9999
Drawing these basics together might produce the following example abstract:
100100
</para>
101101
<para>
102-
"The Red&nbsp;Hat Satellite&nbsp;5.6 API Guide is a full reference for Satellite's XMRPC API. The guide explains each API method and demonstrates examples of data models for input and output. This book provides a basis for administrators and developers to write custom scripts and to integrate Red Hat Satellite with third-party applications."
102+
"The Red&nbsp;Hat Satellite&nbsp;5.6 API Guide is a full reference for Satellite's XMRPC API.
103+
The guide explains each API method and demonstrates examples of data models for input and output.
104+
This book provides a basis for administrators and developers to write custom scripts and to integrate Red&nbsp;Hat Satellite with third-party applications."
103105
</para>
104106
<para>
105107
Update or modify each component according to the type of book that you are writing.
@@ -122,7 +124,7 @@
122124
</section>
123125
<section id="unused-heading-titles">
124126
<title>Unused Heading Titles</title>
125-
<para>
127+
<para>
126128
This section lists various heading titles that might be used in Red&nbsp;Hat technical documentation, but that should be avoided except in specific circumstances.
127129
</para>
128130
<formalpara id="overview">

en-US/Book_Info.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
<!-- Change title to "The Red Hat Style Guide" -->
99
<productname>Red&nbsp;Hat Technical Writing Style&nbsp;Guide</productname>
1010
<productnumber></productnumber>
11-
<edition>6.0</edition>
11+
<edition>6.1</edition>
1212
<pubsnumber>1</pubsnumber>
1313
<abstract>
1414
<para>
15-
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" />
15+
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" />
1616
</para>
1717

1818
</abstract>

en-US/Cross_references.xml

+4-4
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@
4040

4141
</section>
4242
<section id="repeatability-test">
43-
<title>The Repeatability Test</title>
43+
<title>Repetition</title>
4444
<para>
45-
Must the information be repeated?
45+
Repetition is a useful tool for reinforcing new knowledge and skills, emphasizing important ideas, and providing readers with important information at their point of need.
4646
</para>
4747
<para>
48-
This is a hard question, and one that many authors abhor. Often the answer is yes. If the information is vital, and must appear in multiple places, then it must be repeated. It's not a crime. In some circumstances, such is in online help, the reader wants the answer immediately. Do not force even one extra click on them. In a safety situation, it might be the only chance for the reader to find critical information quickly. Any vital information, which is not more than a couple of paragraphs (or half a page, or five rows of a table), can be repeated rather than be cross-referenced to.
48+
Repeating necessary information also saves the reader time and effort. In some circumstances, such as when using online help, the reader is trying to answer an immediate question or to solve a problem. In a safety situation, it is important for the reader to find critical information quickly.
4949
</para>
5050
<para>
51-
Cross-referencing is a good servant but a poor master. Content still rules!
51+
If the information is vital, and must appear in multiple places, then it must be repeated. Any vital information, which is not more than a couple of paragraphs (or half a page, or five rows of a table), can be repeated rather than be cross-referenced to.
5252
</para>
5353

5454
</section>

en-US/D.xml

+6-2
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,6 @@
142142
</listitem>
143143

144144
</varlistentry>
145-
<!-- Added "desire". -->
146145
<varlistentry id="desire">
147146
<term>desire</term>
148147
<listitem>
@@ -210,7 +209,12 @@
210209
<term>digital transformation</term>
211210
<listitem>
212211
<para>
213-
Avoid this phrase. It is vague and could mean use of digital technology to do something faster, to do something differently, or to do a completely new thing. The word "transform" implies a process with a beginning and an end. Some people use the phrase "digital leadership" to describe the ongoing adoption of digital technologies to advance their organization. If you must discuss the concepts of digital transformation or digital leadership, briefly define what you mean on the first occurrence. Describe, rather than label.
212+
Avoid this phrase.
213+
It is vague and could mean use of digital technology to do something faster, to do something differently, or to do something new.
214+
The word "transform" implies a process with a beginning and an end.
215+
Some people use the phrase "digital leadership" to describe the ongoing adoption of digital technologies to advance their organization.
216+
If you must discuss the concepts of digital transformation or digital leadership, briefly define what you mean on the first occurrence.
217+
Describe, rather than label.
214218
</para></listitem>
215219
</varlistentry>
216220
<varlistentry id="disk-druid">

0 commit comments

Comments
 (0)