From c2c5228342f4b31b958e43cc4e3c765a8f2a7428 Mon Sep 17 00:00:00 2001 From: julian-cable Date: Thu, 1 May 2025 16:54:00 +0100 Subject: [PATCH 1/4] A further round of maintenance updates for the 7.1 release --- en-US/A.xml | 138 +++++++++++++++++++++++++++++++---------------- en-US/B.xml | 18 +++---- en-US/C.xml | 30 +++++++---- en-US/D.xml | 14 ++--- en-US/Design.xml | 3 +- en-US/E.xml | 26 ++++++--- en-US/G.xml | 14 +++++ en-US/I.xml | 20 +++---- en-US/New.xml | 26 ++++++++- en-US/S.xml | 18 +++---- 10 files changed, 207 insertions(+), 100 deletions(-) diff --git a/en-US/A.xml b/en-US/A.xml index 72791ed..b2baf69 100644 --- a/en-US/A.xml +++ b/en-US/A.xml @@ -14,6 +14,44 @@ + + + AArch64, aarch64 + + + n. A 64-bit version of the ARM architecture. + Use this term when referring to operating systems and server instances, for example Red Hat Enterprise Linux, Fedora, CoreOS, and other Linux distributions. + + + 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. + + + 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. + + + Examples: + + + + + When running Red Hat Enterprise Linux with an AArch64 system, run the following commands: + + + + + Specify the system architecture of your cluster, such as x86_64 or aarch64. + + + + + Refer also to , , , , , and . + + + + above @@ -102,44 +140,6 @@ - - - AArch64, aarch64 - - - n. A 64-bit version of the ARM architecture. - Use this term when referring to operating systems and server instances, for example Red Hat Enterprise Linux, Fedora, CoreOS, and other Linux distributions. - - - 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. - - - 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. - - - Examples: - - - - - When running Red Hat Enterprise Linux with an AArch64 system, run the following commands: - - - - - Specify the system architecture of your cluster, such as x86_64 or aarch64. - - - - - Refer also to , , , , , and . - - - - AMD64, amd64 @@ -299,21 +299,18 @@ - - as well as + + artificial intelligence (AI) - 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. - as-a-Service + as-a-Service Some as-a-Service acronyms overlap. @@ -412,7 +409,43 @@ - + + + as Code + + + 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. + + + Examples: + + + + + Configuration as Code (CaC) + + + + + + Infrastructure as Code (IaC) + + + + + + Policy as Code (CaC) + + + + + + + + as long as @@ -423,6 +456,19 @@ + + + as well as + + + 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." + + + + ATM diff --git a/en-US/B.xml b/en-US/B.xml index c09cfd3..db17543 100644 --- a/en-US/B.xml +++ b/en-US/B.xml @@ -24,6 +24,15 @@ + + + backtrace + + + n. "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. + + + backup, back up @@ -59,15 +68,6 @@ - - - backtrace - - - n. "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. - - - backwards compatible diff --git a/en-US/C.xml b/en-US/C.xml index 4084c54..478d972 100644 --- a/en-US/C.xml +++ b/en-US/C.xml @@ -248,6 +248,17 @@ + + code base + + + n. Two words. + Do not use "codebase", outside the specific context of codebase.com. + + + + + colocate, colocation @@ -388,16 +399,7 @@ - - Containers-as-a-Service - - - 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 . - - - - container-based @@ -417,6 +419,16 @@ + + + Containers-as-a-Service + + + 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 . + + + + continuous delivery (CD) diff --git a/en-US/D.xml b/en-US/D.xml index bb8f48e..adbd557 100644 --- a/en-US/D.xml +++ b/en-US/D.xml @@ -218,23 +218,23 @@ Describe, rather than label. - - Disk Druid + + disk, disc - Correct. Do not use "Disk druid", "disk druid", or "diskdruid". This is a partitioning tool that is incorporated into Red Hat Enterprise Linux. + Use "compact disc" or "hard disk". + - - disk, disc + + Disk Druid - 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 Hat Enterprise Linux. - diff --git a/en-US/Design.xml b/en-US/Design.xml index 1729dc0..764925d 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -501,7 +501,8 @@ $ vi myFile.txt --> - 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. + For some output formats, no control is possible over where lines would break, and any indentation might appear as extra spaces in inelegant places. diff --git a/en-US/E.xml b/en-US/E.xml index bf7cb4f..7948e7a 100644 --- a/en-US/E.xml +++ b/en-US/E.xml @@ -6,6 +6,17 @@ E + + earlier + + + Use to refer to earlier releases of products. Do not use "older" or related terms. + Refer also to . + + + + + ebook, e-commerce, e-learning, email @@ -15,22 +26,21 @@ - - e.g. + + edge - Red 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"). - - - earlier + + e.g. - Use to refer to earlier releases of products. Do not use "older" or related terms. - Refer also to . + Red Hat technical documentation always expands these abbreviations. Write out "for example". diff --git a/en-US/G.xml b/en-US/G.xml index 9faef8e..9cf59ac 100644 --- a/en-US/G.xml +++ b/en-US/G.xml @@ -102,6 +102,20 @@ + + + generative AI, gen AI + + + 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. + + + 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. + + + + GEO, geo diff --git a/en-US/I.xml b/en-US/I.xml index a9ec824..881a55b 100644 --- a/en-US/I.xml +++ b/en-US/I.xml @@ -25,16 +25,6 @@ - - - Infrastructure as Code (IaC) - - - Based on search volume, the nonhyphenated full term and camel-case acronym are preferred. Use uppercase "I" and "C". - - - - IBM Z @@ -96,6 +86,16 @@ + + + Infrastructure as Code (IaC) + + + Based on search volume, the nonhyphenated full term and camel-case acronym are preferred. Use uppercase "I" and "C". + + + + inline diff --git a/en-US/New.xml b/en-US/New.xml index aebf5cd..e563cf2 100644 --- a/en-US/New.xml +++ b/en-US/New.xml @@ -7,9 +7,29 @@ New in This Release Release 7.1 - Maintenance release in April 2025, with some added and updated guidance. + Maintenance release in May 2025, with some added and updated guidance. + + Added an entry for "artificial intelligence (AI)". + Refer to . + + + Added an entry for "as Code". + Refer to . + + + Added an entry for "code base", to use in preference to "codebase". + Refer to . + + + Added an entry for "edge". + Refer to . + + + Added an entry for "generative AI, gen AI". + Refer to . + Added an entry for "log out of", to use in preference to "log out from". Refer to . @@ -18,6 +38,10 @@ Added an entry for "print queue", to use in preference to "printer queue". Refer to . + + Changed guidance to not use manual line indentation for the second and subsequent lines of commands. + Refer to . + Changed to use hyphenation for "greater-than" and "less-than", to refer to these characters. Refer to . diff --git a/en-US/S.xml b/en-US/S.xml index fc87234..38e3f54 100644 --- a/en-US/S.xml +++ b/en-US/S.xml @@ -546,6 +546,15 @@ + + source + + + v. In addition to the generic use of this term as a noun and verb, in +a programming and technical sense, it also means "Run the source command against the named file." + + + Source-Navigator™ @@ -556,15 +565,6 @@ - - source - - - v. In addition to the generic use of this term as a noun and verb, in -a programming and technical sense, it also means "Run the source command against the named file." - - - space From b67701ecd731bc299e8c794547738fa2a9bbad9e Mon Sep 17 00:00:00 2001 From: julian-cable Date: Tue, 6 May 2025 10:55:22 +0100 Subject: [PATCH 2/4] Add dollar sign --- en-US/New.xml | 4 ++++ en-US/Punctuation.xml | 7 ++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/en-US/New.xml b/en-US/New.xml index e563cf2..739deae 100644 --- a/en-US/New.xml +++ b/en-US/New.xml @@ -42,6 +42,10 @@ Changed guidance to not use manual line indentation for the second and subsequent lines of commands. Refer to . + + Added the dollar sign to the table of punctuation marks and special characters. + Refer to . + Changed to use hyphenation for "greater-than" and "less-than", to refer to these characters. Refer to . diff --git a/en-US/Punctuation.xml b/en-US/Punctuation.xml index 9dee574..4c3a0fe 100644 --- a/en-US/Punctuation.xml +++ b/en-US/Punctuation.xml @@ -800,7 +800,7 @@ Using project "default". Referring to Special Characters - When a regular user starts a shell, the prompt includes an ending dollar character ($). + When a regular user starts a shell, the prompt includes an ending dollar sign ($). Use the pipe character (|) to send the output of one program to the input of another program. @@ -904,6 +904,11 @@ Using project "default". , Comma + + + $ + Dollar sign + " or “ ” From a912cf1b10ab6c06538b66f5b7f76cf0d6cfeae2 Mon Sep 17 00:00:00 2001 From: julian-cable Date: Fri, 9 May 2025 11:25:03 +0100 Subject: [PATCH 3/4] Minor fix --- en-US/A.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en-US/A.xml b/en-US/A.xml index b2baf69..fd46464 100644 --- a/en-US/A.xml +++ b/en-US/A.xml @@ -437,7 +437,7 @@ - Policy as Code (CaC) + Policy as Code (PaC) From cbf3530208831669f5f83a662a4239d49d300397 Mon Sep 17 00:00:00 2001 From: julian-cable Date: Mon, 12 May 2025 14:19:25 +0100 Subject: [PATCH 4/4] Further fix --- en-US/A.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en-US/A.xml b/en-US/A.xml index fd46464..044cebd 100644 --- a/en-US/A.xml +++ b/en-US/A.xml @@ -313,7 +313,7 @@ as-a-Service - Some as-a-Service acronyms overlap. + Some "as-a-Service" acronyms overlap. To avoid confusion, always spell out the full term on first use. @@ -416,7 +416,7 @@ Use camel case for both the full term and the acronym. Do not hyphenate. - Some as Code acronyms might overlap. + Some "as Code" acronyms might overlap. To avoid confusion, always spell out the full term on first use.