Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
93 commits
Select commit Hold shift + click to select a range
ce9dd60
Working on #450.
Dec 19, 2022
c00a40e
Run Vale over Design.xml.
Jan 23, 2023
d2cb422
Merge pull request #459 from StyleGuides/daobrien/450-vale-check
daobrien Jan 24, 2023
1de7eec
Ongoing updates for #456
Feb 1, 2023
70453b7
Closes #456
Feb 2, 2023
1e7ae19
s/may/might/ per Julian's review.
Feb 2, 2023
0acc4d3
Merge pull request #462 from StyleGuides/daobrien/456-vale-check
daobrien Feb 2, 2023
d82ff7a
Working on #457 Run Vale of the style guide part 3.
Feb 2, 2023
2733a9c
Closes #457 Run Vale over the style guide, part 3.
Feb 3, 2023
06426b0
Remove spurious space.
Feb 6, 2023
d1a34ef
Merge pull request #464 from StyleGuides/daobrien/457-vale-check
daobrien Feb 8, 2023
bd57d57
Closes #458 Run Vale over style guide part 4.
Feb 9, 2023
a199ab2
Merge pull request #467 from StyleGuides/daobrien/458-vale-check
daobrien Feb 13, 2023
3d9f18c
Closes #365 Remove DocBook references.
Feb 13, 2023
85fc2f4
Closes #78 Update entry for "virtualized".
Feb 13, 2023
3335f18
Closes #355. Improve a bit of formatting.
Feb 13, 2023
10d5f01
Merge pull request #470 from StyleGuides/daobrien/355-app-velocity
daobrien Feb 13, 2023
847e124
Merge pull request #468 from StyleGuides/daobrien/365-remove-docbook-…
mweetman-redhat Feb 13, 2023
f0b0201
Merge pull request #469 from StyleGuides/daobrien/78-update-virtualized
daobrien Mar 10, 2023
c9f5eb8
feat: Add advice on naming the default branch in an inclusive way. (#…
CBID2 Jun 22, 2023
560c4df
Updated section about writing titles (#492)
julian-cable Jun 23, 2023
3993109
Updated guidance on continuation prompts (#494)
julian-cable Jun 30, 2023
05c8e06
Various fixes for 6.1 release (#495)
julian-cable Jul 5, 2023
4a27046
Updated IBM Style access info (#496)
julian-cable Jul 5, 2023
513f647
Updated term entries (#497)
julian-cable Jul 7, 2023
4cd5492
Added guidance on omitting part of an output (#500)
julian-cable Jul 14, 2023
4a0e728
Updated sample names and other small fixes (#502)
julian-cable Jul 21, 2023
02fcf95
Various fixes (#512)
julian-cable Aug 4, 2023
7ccd2bd
Implementing various feedback suggestions from Rachel (#513)
julian-cable Aug 4, 2023
91d9a95
Added more punctuation guidance (#515)
julian-cable Aug 8, 2023
bc18591
Updated audience description (#518)
julian-cable Aug 15, 2023
b6dba5a
Adding information about posessives (#519)
CBID2 Aug 16, 2023
267f8c9
Updated view and edit files section
julian-cable Aug 16, 2023
82b1019
Merge pull request #520 from StyleGuides/jcable/516-docbook-refs
daobrien Aug 17, 2023
0720e2c
Added release notes for 6.1 and updated version information (#522)
julian-cable Aug 22, 2023
f6a12a6
updating homepage (#525)
harpasin Aug 23, 2023
be39016
6.2 quick fixes (#544)
julian-cable Nov 14, 2023
9daece9
Some updates concerning punctuation (#545)
julian-cable Nov 21, 2023
a353d5e
Word usage updates: screenshot, lookup, see/refer to (#546)
julian-cable Nov 23, 2023
0c182df
Line continuation for multiple operating systems (#548)
julian-cable Nov 27, 2023
1fb8f6c
Add 64-bit architecture guidance (#547)
julian-cable Nov 28, 2023
e1f9e88
Updated Boolean guidance and a bug fix (#551)
julian-cable Dec 22, 2023
1d86161
Reworked entries for tar, tarball, untar, unzip, zip (#552)
julian-cable Jan 3, 2024
5ce7b81
Clarify capitalization for table titles (#553)
julian-cable Jan 18, 2024
a74a648
Updates on referring to object names and using realistic usernames (#…
julian-cable Jan 19, 2024
816aeef
Updates for apostrophes and quotation marks (#557)
julian-cable Feb 1, 2024
2b61ea8
Updated guidance about titles (#559)
julian-cable Feb 2, 2024
e8141a2
Footnote update (#560)
harpasin Feb 5, 2024
5061af2
fix(docs): add some build instructions (#562)
alexpdp7 Feb 21, 2024
09d18cf
Corrected some titles to use title case (#563)
julian-cable Feb 26, 2024
338068b
Add release notes and update version info (#564)
julian-cable Feb 26, 2024
16aa548
Merge branch 'master' into dev
julian-cable Feb 27, 2024
1604485
Remove 'check' entry (#579)
julian-cable Jun 21, 2024
c43737e
Add 'sign-in' (#580)
julian-cable Jul 1, 2024
9b08622
Implement suggestions from Ashley D'Andrea (#589)
julian-cable Jul 4, 2024
cf841d4
Add guidance for 'named' and 'called' (#591)
julian-cable Jul 8, 2024
c26613a
Update guidance for 'go to' (#592)
julian-cable Jul 9, 2024
513336f
Add gitignore for untracked files (#590)
jdandrea Jul 9, 2024
15d08be
Update guidance about 'Overview' as a title (#593)
julian-cable Jul 29, 2024
a0cadb8
Clarify guidance for 'lifecycle' (#594)
julian-cable Jul 29, 2024
55be389
Remove yes/no as values for Ansible 'become'
bonnevil Aug 15, 2024
812c304
Edits to address feedback in #600
bonnevil Aug 15, 2024
ca59fa4
Update en-US/Design.xml
rclee33 Aug 19, 2024
28f41d4
Update en-US/Design.xml
rclee33 Aug 19, 2024
c5e3012
fixes two sentences on one line
rclee33 Aug 19, 2024
3fea407
Merge pull request #600 from StyleGuides/sbonnevi/ansible-booleans
rclee33 Aug 19, 2024
5062e48
Update 'dialog box' entry (#603)
julian-cable Aug 20, 2024
578190b
Various fixes (#604)
julian-cable Aug 22, 2024
ce1d2a4
Add 'mission-critical'
julian-cable Aug 29, 2024
3e945ea
Add EPUB
julian-cable Aug 29, 2024
049d569
Implement comments
julian-cable Aug 29, 2024
14d125a
Implement comments
julian-cable Aug 29, 2024
ee70088
Final fix
julian-cable Aug 30, 2024
b6e39ec
Final fix
julian-cable Aug 30, 2024
993e01c
Merge pull request #607 from StyleGuides/jcable/mission-critical-596
daobrien Sep 2, 2024
faa4724
Merge pull request #608 from StyleGuides/jcable/epub-599
daobrien Sep 2, 2024
60c37b7
Update references to IBM Style with links, and remove marketing refer…
julian-cable Sep 13, 2024
8aeba4e
Update IaC (#612)
julian-cable Sep 13, 2024
30a4602
Updates for dashes, terminal, omitting output (#618)
julian-cable Sep 25, 2024
1c6d3f0
Update abstract wording (#619)
julian-cable Sep 25, 2024
11d61ab
Add release notes (#620)
julian-cable Sep 27, 2024
f1cb2a5
Add 'hardened', update 'secure', update omitted output (#621)
julian-cable Oct 3, 2024
e4d7e7e
Use content from dev branch rather than from master in cases of confl…
julian-cable Oct 9, 2024
7aff829
Updated audience section for Homepage (#623)
harpasin Oct 10, 2024
4ea5533
updating index page for v7.0 (#624)
harpasin Oct 15, 2024
e18561d
Add dark mode enhancement to What's New (#626)
julian-cable Nov 21, 2024
dfe90d1
Some maintenance updates for 7.1 (#635)
julian-cable Mar 25, 2025
9f06c35
A further round of maintenance updates for the 7.1 release (#641)
julian-cable May 12, 2025
ba3f185
Jcable/allow object class (#643)
julian-cable Jun 2, 2025
60c0021
Minor typing fix (#644)
julian-cable Jun 2, 2025
3fe15f7
Minor fixes for 'referring to' section
julian-cable Jun 3, 2025
40b6351
Merge pull request #646 from StyleGuides/jcable/referring
daobrien Jun 3, 2025
e00773f
resolving conflicts
harpasin Jun 3, 2025
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
140 changes: 93 additions & 47 deletions en-US/A.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,44 @@
</para>
</listitem>

</varlistentry>
<varlistentry id="aarch64">
<term role="true">AArch64, aarch64</term>
<listitem>
<para>
<emphasis>n.</emphasis> A 64-bit version of the ARM architecture.
Use this term when referring to operating systems and server instances, for example Red&nbsp;Hat Enterprise Linux, Fedora, CoreOS, and other Linux distributions.
</para>
<para>
Use the uppercase (AArch64) format in general cases when referring to system architecture.
Use the lowercase (aarch64) format only when referring to objects or parameters.
It can be styled as code (monospace font or a code-styled block) when referring to code.
</para>
<para>
Cloud providers might use different formats of this term to refer to architectures.
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
</para>
<para>
Examples:
</para>
<itemizedlist>
<listitem>
<para>
When running Red&nbsp;Hat Enterprise Linux with an AArch64 system, run the following commands:
</para>
</listitem>
<listitem>
<para>
Specify the system architecture of your cluster, such as <code>x86_64</code> or <code>aarch64</code>.
</para>
</listitem>
</itemizedlist>
<para>
Refer also to <xref linkend="a64-bit"/>, <xref linkend="a64-bit-x86"/>, <xref linkend="AMD64"/>, <xref linkend="ARM64"/>, <xref linkend="Intel64"/>, and <xref linkend="x86-64"/>.
</para>

</listitem>

</varlistentry>
<varlistentry id="above">
<term role="caution">above</term>
Expand Down Expand Up @@ -102,44 +140,6 @@

</listitem>

</varlistentry>
<varlistentry id="aarch64">
<term role="true">AArch64, aarch64</term>
<listitem>
<para>
<emphasis>n.</emphasis> A 64-bit version of the ARM architecture.
Use this term when referring to operating systems and server instances, for example Red&nbsp;Hat Enterprise Linux, Fedora, CoreOS, and other Linux distributions.
</para>
<para>
Use the uppercase (AArch64) format in general cases when referring to system architecture.
Use the lowercase (aarch64) format only when referring to objects or parameters.
It can be styled as code (monospace font or a code-styled block) when referring to code.
</para>
<para>
Cloud providers might use different formats of this term to refer to architectures.
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
</para>
<para>
Examples:
</para>
<itemizedlist>
<listitem>
<para>
When running Red&nbsp;Hat Enterprise Linux with an AArch64 system, run the following commands:
</para>
</listitem>
<listitem>
<para>
Specify the system architecture of your cluster, such as <code>x86_64</code> or <code>aarch64</code>.
</para>
</listitem>
</itemizedlist>
<para>
Refer also to <xref linkend="a64-bit"/>, <xref linkend="a64-bit-x86"/>, <xref linkend="AMD64"/>, <xref linkend="ARM64"/>, <xref linkend="Intel64"/>, and <xref linkend="x86-64"/>.
</para>

</listitem>

</varlistentry>
<varlistentry id="AMD64">
<term role="true">AMD64, amd64</term>
Expand Down Expand Up @@ -299,24 +299,21 @@
</para>
</listitem>
</varlistentry>
<varlistentry id="as-well-as">
<term role="caution">as well as</term>
<varlistentry id="artificial-intelligence">
<term>artificial intelligence (AI)</term>
<listitem>
<para>
Not interchangeable with "and".
"As well as" used in a series places more emphasis on the items preceding it, whereas "and" places equal weight on all items in the series.
For example, "We sell kitchen electronics and china, as well as some gourmet foods."
But "We sell kitchen electronics, china, and silverware."
Unless clarity requires it or the concept is being introduced or explained, "artificial intelligence" does not have to be spelled out on first use; "AI" is understood and suffices. When spelling it out, do not capitalize the term.
</para>

</listitem>

</varlistentry>
<varlistentry id="as-a-service">
<term role="caution">as-a-Service</term>
<term>as-a-Service</term>
<listitem>
<para>
Some as-a-Service acronyms overlap.
Some "as-a-Service" acronyms overlap.
To avoid confusion, always spell out the full term on first use.
</para>
<itemizedlist>
Expand Down Expand Up @@ -412,7 +409,43 @@

</listitem>

<!-- Suggested addition of "as long as" -->
</varlistentry>
<varlistentry id="as-code">
<term>as Code</term>
<listitem>
<para>
Use camel case for both the full term and the acronym.
Do not hyphenate.
Some "as Code" acronyms might overlap.
To avoid confusion, always spell out the full term on first use.
</para>
<para>
Examples:
</para>
<itemizedlist>
<listitem>
<para>
Configuration as Code (CaC)
</para>

</listitem>
<listitem>
<para>
Infrastructure as Code (IaC)
</para>

</listitem>
<listitem>
<para>
Policy as Code (PaC)
</para>

</listitem>

</itemizedlist>

</listitem>

</varlistentry>
<varlistentry id="as-long-as">
<term role="caution">as long as</term>
Expand All @@ -423,6 +456,19 @@

</listitem>

</varlistentry>
<varlistentry id="as-well-as">
<term role="caution">as well as</term>
<listitem>
<para>
Not interchangeable with "and".
"As well as" used in a series places more emphasis on the items preceding it, whereas "and" places equal weight on all items in the series.
For example, "We sell kitchen electronics and china, as well as some gourmet foods."
But "We sell kitchen electronics, china, and silverware."
</para>

</listitem>

</varlistentry>
<varlistentry id="atm">
<term role="true">ATM</term>
Expand Down
18 changes: 9 additions & 9 deletions en-US/B.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@

</listitem>

</varlistentry>
<varlistentry id="backtrace">
<term>backtrace</term>
<listitem>
<para>
<emphasis>n.</emphasis> "Backtrace" is the most common term to refer to a stack trace (or stack backtrace), which is a report of the active stack frames (that is, function calls) at a certain point in time during the execution of a program. In contrast, the Python programming language calls its stack trace a "traceback", possibly because the stack frames are printed in the opposite order of those presented by gdb, the GNU Debugger. "Traceback" is the preferred term when referring to a Python stack trace.
</para>

</listitem>
</varlistentry>
<varlistentry id="back-up">
<term>backup, back up</term>
Expand Down Expand Up @@ -59,15 +68,6 @@

</listitem>

</varlistentry>
<varlistentry id="backtrace">
<term>backtrace</term>
<listitem>
<para>
<emphasis>n.</emphasis> "Backtrace" is the most common term to refer to a stack trace (or stack backtrace), which is a report of the active stack frames (that is, function calls) at a certain point in time during the execution of a program. In contrast, the Python programming language calls its stack trace a "traceback", possibly because the stack frames are printed in the opposite order of those presented by gdb, the GNU Debugger. "Traceback" is the preferred term when referring to a Python stack trace.
</para>

</listitem>
</varlistentry>
<varlistentry id="backwards-compatible">
<term>backwards compatible</term>
Expand Down
2 changes: 1 addition & 1 deletion en-US/Book_Info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<!-- Change title to "The Red Hat Style Guide" -->
<productname>Red&nbsp;Hat Technical Writing Style&nbsp;Guide</productname>
<productnumber></productnumber>
<edition>7.0</edition>
<edition>7.1</edition>
<pubsnumber>1</pubsnumber>
<abstract>
<para>
Expand Down
30 changes: 21 additions & 9 deletions en-US/C.xml
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,17 @@
</listitem>

</varlistentry>
<varlistentry id="code-base">
<term>code base</term>
<listitem>
<para>
<emphasis>n.</emphasis> Two words.
Do not use "codebase", outside the specific context of codebase.com.
</para>

</listitem>

</varlistentry>
<!-- Added "colocate, colocation" -->
<varlistentry id="colocate">
<term>colocate, colocation</term>
Expand Down Expand Up @@ -388,16 +399,7 @@
</listitem>

</varlistentry>
<varlistentry id="containers-as-a-service">
<term>Containers-as-a-Service</term>
<listitem>
<para>
The term "Containers-as-a-Service" is owned by Docker and should be used only when referring to that company's offering. Refer also to <xref linkend="as-a-service" />.
</para>

</listitem>

</varlistentry>
<varlistentry id="container-based">
<term>container-based</term>
<listitem>
Expand All @@ -417,6 +419,16 @@

</listitem>

</varlistentry>
<varlistentry id="containers-as-a-service">
<term>Containers-as-a-Service</term>
<listitem>
<para>
The term "Containers-as-a-Service" is owned by Docker and should be used only when referring to that company's offering. Refer also to <xref linkend="as-a-service" />.
</para>

</listitem>

</varlistentry>
<varlistentry id="continuous-delivery">
<term>continuous delivery (CD)</term>
Expand Down
14 changes: 7 additions & 7 deletions en-US/D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -218,23 +218,23 @@
Describe, rather than label.
</para></listitem>
</varlistentry>
<varlistentry id="disk-druid">
<term>Disk Druid</term>
<varlistentry id="disk-disc">
<term>disk, disc</term>
<listitem>
<para>
Correct. Do not use "Disk druid", "disk druid", or "diskdruid". This is a partitioning tool that is incorporated into Red&nbsp;Hat Enterprise&nbsp;Linux.
Use "compact disc" or "hard disk".
</para>
<!-- Removed reference to "diskette". -->

</listitem>

</varlistentry>
<varlistentry id="disk-disc">
<term>disk, disc</term>
<varlistentry id="disk-druid">
<term>Disk Druid</term>
<listitem>
<para>
Use "compact disc" or "hard disk".
Correct. Do not use "Disk druid", "disk druid", or "diskdruid". This is a partitioning tool that is incorporated into Red&nbsp;Hat Enterprise&nbsp;Linux.
</para>
<!-- Removed reference to "diskette". -->

</listitem>

Expand Down
Loading