Skip to content

A further round of maintenance updates for the 7.1 release #641

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
julian-cable merged 4 commits into from
May 12, 2025
Merged

A further round of maintenance updates for the 7.1 release #641

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
c2c5228
A further round of maintenance updates for the 7.1 release
julian-cable May 1, 2025
b67701e
Add dollar sign
julian-cable May 6, 2025
a912cf1
Minor fix
julian-cable May 9, 2025
cbf3530
Further fix
julian-cable May 12, 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
View file
Open in desktop
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
View file
Open in desktop
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
30 changes: 21 additions & 9 deletions en-US/C.xml
View file
Open in desktop
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
View file
Open in desktop
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
3 changes: 2 additions & 1 deletion en-US/Design.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,7 +501,8 @@ $ vi myFile.txt
</para>
</important> -->
<para>
You can also indent the second and subsequent lines of such commands to assist in clarity and readability if required.
Do not use manual line indentation for the second and subsequent lines of commands.
Copy link
Contributor

@rclee33 rclee33 May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noting that I will update the Confluence page about multiline commands to align with this guidance. I know we usually avoid duplicating guidance, but in this case, I think this guidance must be documented in both places.

For some output formats, no control is possible over where lines would break, and any indentation might appear as extra spaces in inelegant places.
<!-- You can use this option for any of these designs. -->
</para>

Expand Down
26 changes: 18 additions & 8 deletions en-US/E.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@
<chapter id="e">
<title>E</title>
<variablelist>
<varlistentry id="earlier">
<term>earlier</term>
<listitem>
<para>
Use to refer to earlier releases of products. Do not use "older" or related terms.
Refer also to <xref linkend="later" />.
</para>

</listitem>

</varlistentry>
<varlistentry id="e-book">
<term>ebook, e-commerce, e-learning, email</term>
<listitem>
Expand All @@ -15,22 +26,21 @@
</listitem>

</varlistentry>
<varlistentry id="eg">
<term>e.g.</term>
<varlistentry id="edge">
<term>edge</term>
<listitem>
<para>
Red&nbsp;Hat technical documentation always expands these abbreviations. Write out "for example".
Describes network elements outside the gateway and server-side or cloud-side functions (for example, "an edge device").
Do not refer to "the edge" without qualifying it; define the first instance (for example, "the edge of the network").
</para>

</listitem>

</varlistentry>
<varlistentry id="earlier">
<term>earlier</term>
<varlistentry id="eg">
<term>e.g.</term>
<listitem>
<para>
Use to refer to earlier releases of products. Do not use "older" or related terms.
Refer also to <xref linkend="later" />.
Red&nbsp;Hat technical documentation always expands these abbreviations. Write out "for example".
</para>

</listitem>
Expand Down
14 changes: 14 additions & 0 deletions en-US/G.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,20 @@

</listitem>

</varlistentry>
<varlistentry id="gen-ai">
<term>generative AI, gen AI</term>
<listitem>
<para>
Unless clarity requires it or the concept is being introduced or explained, "generative artificial intelligence" does not have to be spelled out on first use; the abbreviation "gen AI" is understood and suffices.
When spelling it out, do not capitalize the term.
</para>
<para>
Note: Because generative AI is a relatively new technology concept, the term and how it is applied is evolving, so this guidance might change accordingly.
</para>

</listitem>

</varlistentry>
<varlistentry id="geo">
<term>GEO, geo</term>
Expand Down
Loading