Skip to content

Commit 0ef3877

Browse files
authored
Merge pull request #261 from Sarka-Jana/glossary-rhel-software-management
Add new terms for glossary: RHEL software management
2 parents 8388f54 + e9b8537 commit 0ef3877

File tree

12 files changed

+227
-17
lines changed

12 files changed

+227
-17
lines changed

supplementary_style_guide/glossary_terms_conventions/general_conventions/a.adoc

+22
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ _Specify the system architecture of your cluster, such as `x86_64` or `aarch64`.
149149
*See also*: xref:activemq-artemis[ActiveMQ Artemis], xref:jboss-eap-messaging[JBoss EAP messaging]
150150

151151
// EAP: Added "In Red Hat JBoss Enterprise Application Platform,"
152+
152153
[[activemq-artemis]]
153154
==== image:images/caution.png[with caution] ActiveMQ Artemis (noun)
154155
*Description*: In Red Hat JBoss Enterprise Application Platform, use "ActiveMQ Artemis" only when describing the technology used to implement the built-in messaging for JBoss EAP.
@@ -409,6 +410,16 @@ An Ansible task is a set of instructions to achieve a state defined, in its broa
409410

410411
*See also*: xref:app[app]
411412

413+
[[application-stream]]
414+
==== image:images/yes.png[yes] Application Stream (noun)
415+
*Description*: _Application Streams_ are multiple versions of Red Hat Enterprise Linux user-space components that are delivered and updated more frequently than the core operating system packages. Application Streams can be packaged as RPM packages, modules, or Software Collections. Do not confuse Application Streams with "AppStream", the repository through which Application Streams and other components are distributed.
416+
417+
*Use it*: yes
418+
419+
*Incorrect forms*: AppStream, application stream, Application stream
420+
421+
*See also*: xref:appstream-repository[AppStream repository]
422+
412423
[[applixware]]
413424
==== image:images/yes.png[yes] Applixware (noun)
414425
*Description*: _Applixware_ is a suite of proprietary modular applications for Linux.
@@ -419,6 +430,16 @@ An Ansible task is a set of instructions to achieve a state defined, in its broa
419430

420431
*See also*:
421432

433+
[[appstream-repository]]
434+
==== image:images/yes.png[yes] AppStream repository (noun)
435+
*Description*: The _AppStream repository_ distributes RHEL content as Application Streams and other components. Do not confuse the AppStream repository with the Application Streams that it distributes.
436+
437+
*Use it*: yes
438+
439+
*Incorrect forms*: Appstream, appstream, Application Stream
440+
441+
*See also*: xref:application-stream[Application Stream]
442+
422443
[[arp]]
423444
==== image:images/yes.png[yes] ARP (noun)
424445
*Description*: Within a subnet of an Ethernet network, hosts use the Address Resolution Protocol (_ARP_) to discover the Media Access Control (MAC) address that is associated with an IPv4 address. In IPv6 networks, the Neighbor Discovery Protocol (NDP) provides the functionality of ARP.
@@ -568,6 +589,7 @@ An Ansible task is a set of instructions to achieve a state defined, in its broa
568589

569590
*See also*: xref:xplat[Microsoft Azure Cross-Platform Command-Line Interface]
570591

592+
571593
[[arm64]]
572594
==== image:images/yes.png[yes] ARM64 (noun)
573595
*Description*: A 64-bit version of the ARM architecture. Use this term for OpenShift Container Platform (OCP) attributes, Kubernetes, Operators, APIs, and CLI objects. Use this format in general sentences when referring to OCP features.

supplementary_style_guide/glossary_terms_conventions/general_conventions/b.adoc

+40
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,16 @@
7171

7272
*See also*: xref:distinguished-name[distinguished name]
7373

74+
[[baseos-repository]]
75+
==== image:images/yes.png[yes] BaseOS repository (noun)
76+
*Description*: In Red Hat Enterprise Linux, the _BaseOS repository_ contains the core set of the underlying operating system functionality that provides the foundation for all installations.
77+
78+
*Use it*: yes
79+
80+
*Incorrect forms*: Baseos, baseos, baseOS
81+
82+
*See also*:
83+
7484
[[basic-http-authentication]]
7585
==== image:images/yes.png[yes] Basic HTTP authentication (noun)
7686
*Description*: _Basic HTTP authentication_, or _Basic authentication_, is an authorization scheme that uses HTTP to send login credentials encoded in Base64.
@@ -147,6 +157,16 @@ The practice of having both modes together is often referred to as _hybrid_, _ag
147157

148158
*See also*:
149159

160+
[[binary-rpm]]
161+
==== image:images/yes.png[yes] binary RPM (noun)
162+
*Description*: A _binary RPM_ is an RPM package that contains the binaries built from sources and patches.
163+
164+
*Use it*: yes
165+
166+
*Incorrect forms*:
167+
168+
*See also*: xref:rpm[RPM]
169+
150170
[[bind]]
151171
==== image:images/yes.png[yes] BIND (noun)
152172
*Description*: Use "BIND" when referring to the DNS software.
@@ -212,6 +232,16 @@ Do not use "BIOS" as a generic term to refer to computer firmware. Use "firmware
212232

213233
*See also*: xref:filestore[FileStore], xref:object-store[Object Store]
214234

235+
[[boolean-dependencies]]
236+
==== image:images/yes.png[yes] Boolean dependencies (noun)
237+
*Description*: In Red Hat Enterprise Linux, _Boolean dependencies_ are Boolean expressions such as `if`, `and`, `or`, and other expressions that are used in the `Requires`, `Conflicts`, and `Weak` dependency directives. Boolean dependencies are also known as _Rich dependencies_.
238+
239+
*Use it*: yes
240+
241+
*Incorrect forms*:
242+
243+
*See also*: xref:weak-dependencies[Weak dependencies]
244+
215245
[[boot-disk]]
216246
==== image:images/yes.png[yes] boot disk (noun)
217247
*Description*: A _boot disk_ is a disk used to start a computer.
@@ -485,3 +515,13 @@ Do not use "BIOS" as a generic term to refer to computer firmware. Use "firmware
485515
*Incorrect forms*: byte code
486516

487517
*See also*:
518+
519+
[[byte-compiled-program]]
520+
==== image:images/yes.png[yes] byte-compiled program (noun)
521+
*Description*: _Byte-compiled programs_ are programs that must be compiled into bytecode before they can run in a language virtual machine.
522+
523+
*Use it*: yes
524+
525+
*Incorrect forms*:
526+
527+
*See also*: xref:interpreted-code[interpreted code]

supplementary_style_guide/glossary_terms_conventions/general_conventions/c.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,16 @@
398398

399399
*See also*:
400400

401+
[[codeready-linux-builder-repository]]
402+
==== image:images/caution.png[with caution] CodeReady Linux Builder repository (noun)
403+
*Description*: In Red Hat Enterpise Linux, the _CodeReady Linux Builder repository_ provides additional packages for use by developers. Red Hat does not support packages included in the CodeReady Linux Builder repository. Do not use a shortened form of this term. Always mention that packages in this repository are unsupported.
404+
405+
*Use it*: with caution
406+
407+
*Incorrect forms*: codeready Linux builder, CRB
408+
409+
*See also*:
410+
401411
[[codebase]]
402412
==== image:images/yes.png[yes] codebase (noun)
403413
*Description*: A _codebase_ is a complete collection of source code for a software component, application, or system. Write as shown: one word.

supplementary_style_guide/glossary_terms_conventions/general_conventions/d.adoc

+12-4
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ The API object for a deployment can be either a Kubernetes-native `Deployment` o
221221
// EAP: Added "In Red Hat JBoss Enterprise Application Platform,"
222222
[[deployment-scanner]]
223223
==== image:images/yes.png[yes] deployment-scanner subsystem (noun)
224-
*Description*: In Red Hat JBoss Enterprise Application Platform, the _deployment-scanner subsystem_ is used to configure scanners to check for applications to deploy. In general text, write in lowercase as two words separated by a hyphen. Use "Deployment Scanners subsystem" when referring to the `deployment-scanner` subsystem in titles and headings. When writing the term in its heading form, ensure that you include a plural 's'.
224+
*Description*: In Red Hat JBoss Enterprise Application Platform, the _deployment-scanner subsystem_ is used to configure scanners to check for applications to deploy. In general text, write in lowercase as two words separated by a hyphen. Use "Deployment Scanners subsystem" when referring to the `deployment-scanner` subsystem in titles and headings. When writing the term in its heading form, ensure that you include a plural 's'.
225225

226226
*Use it*: yes
227227

@@ -369,7 +369,6 @@ The API object for a deployment can be either a Kubernetes-native `Deployment` o
369369
*See also*:
370370

371371
// RHEL: Added "In Red Hat Enterprise Linux,"; Lowercased entry to "directory server" and updated in description
372-
// TODO: See if it was right to lowercase this
373372
[[directory-server]]
374373
==== image:images/yes.png[yes] directory server (noun)
375374
*Description*: In Red Hat Enterprise Linux, a _directory server_ centralizes user identity and application information. It provides an operating system-independent, network-based registry for storing application settings, user profiles, group data, policies, and access control information. Each resource on the network is considered an object by the directory server. Information about a particular resource is stored as a collection of attributes associated with that resource or object.
@@ -446,6 +445,16 @@ Red Hat Directory Server conforms to LDAP standards.
446445

447446
*See also*:
448447

448+
[[dnf-automatic]]
449+
==== image:images/yes.png[yes] DNF Automatic (noun)
450+
*Description*: Use _DNF Automatic_ to refer to a Red Hat Enterprise Linux command-line interface suited for automatic and regular package updates.
451+
452+
*Use it*: yes
453+
454+
*Incorrect forms*: DNF automatic, dnf automatic
455+
456+
*See also*:
457+
449458
[[dns]]
450459
==== image:images/yes.png[yes] DNS (noun)
451460
*Description*: _DNS_ is an abbreviation for "Domain Name System" or "Domain Name Service", a service that translates domain names into IP addresses and vice versa.
@@ -492,7 +501,7 @@ Red Hat Directory Server conforms to LDAP standards.
492501
// RHEL: Added "In Red Hat Enterprise Linux,"
493502
[[domain-controller]]
494503
==== image:images/yes.png[yes] domain controller (noun)
495-
*Description*: In Red Hat Enterprise Linux, a _domain controller (DC)_ is a host that responds to security authentication requests within a domain and controls access to resources in that domain.
504+
*Description*: In Red Hat Enterprise Linux, a _domain controller (DC)_ is a host that responds to security authentication requests within a domain and controls access to resources in that domain. IdM servers work as DCs for the IdM domain. A DC authenticates users, stores user account information and enforces security policy for a domain. When a user logs into a domain, the DC authenticates and validates their credentials and either allows or denies access.
496505

497506
*Use it*: yes
498507

@@ -521,7 +530,6 @@ Red Hat Directory Server conforms to LDAP standards.
521530

522531
*See also*:
523532

524-
525533
[[download-n]]
526534
==== image:images/yes.png[yes] download (noun)
527535
*Description*: Use "download" as a noun when referring to software, data, and so on that is being retrieved from another computer.

supplementary_style_guide/glossary_terms_conventions/general_conventions/f.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,16 @@ Use the hyphenated "fault-tolerant" when using it as an adjective.
8686

8787
*See also*: xref:bluestore[BlueStore]
8888

89+
[[file-trigger-directive]]
90+
==== image:images/yes.png[yes] file trigger directive (noun)
91+
*Description*: In Red Hat Enterprise Linux, a _file trigger directive_ is a special form of a transaction scriptlet that runs conditionally when matching files from other packages are installed or uninstalled.
92+
93+
*Use it*: yes
94+
95+
*Incorrect forms*:
96+
97+
*See also*:
98+
8999
[[firewalld]]
90100
==== image:images/yes.png[yes] firewalld (noun)
91101
*Description*: The _firewalld_ service provides a dynamically managed firewall with support for zones that define the trust level of network connections or interfaces. Write as shown (all lowercase).

supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -524,6 +524,16 @@ _This feature can run only on Intel 64 processors_
524524

525525
*See also*:
526526

527+
[[interpreted-code]]
528+
==== image:images/yes.png[yes] interpreted code (noun)
529+
*Description*: In Red Hat Enterprise Linux, _interpreted code_ is source code that runs step-by-step, without prior transformations by a language interpreter or a language virtual machine.
530+
531+
*Use it*: yes
532+
533+
*Incorrect forms*:
534+
535+
*See also*: xref:raw-interpreted-program[raw-interpreted program], xref:byte-compiled-program[byte-compiled program]
536+
527537
// RHEL: Added "In Red Hat Enterprise Linux, an inventory is"
528538
[[inventory]]
529539
==== image:images/yes.png[yes] inventory (noun)

supplementary_style_guide/glossary_terms_conventions/general_conventions/m.adoc

+30
Original file line numberDiff line numberDiff line change
@@ -474,6 +474,36 @@ Azure CLI 2.0 is the most current command-line interface and is replacing Xplat-
474474

475475
*See also*:
476476

477+
[[module]]
478+
==== image:images/yes.png[yes] module (noun)
479+
*Description*: In Red Hat Enterprise Linux, a _module_ is a collection of packages representing a logical unit: an application, a language stack, a database, or a set of tools. These packages are built, tested, and released together.
480+
481+
*Use it*: yes
482+
483+
*Incorrect forms*:
484+
485+
*See also*:
486+
487+
[[module-profile]]
488+
==== image:images/yes.png[yes] module profile (noun)
489+
*Description*: In Red Hat Enterprise Linux, a _module profile_ is a list of recommended packages to be installed together for a particular use case such as for a server, client, development, or minimal installation. These package lists can contain packages outside the module stream, usually from the BaseOS repository or the dependencies of the stream.
490+
491+
*Use it*: yes
492+
493+
*Incorrect forms*:
494+
495+
*See also*: xref:baseos-repository[BaseOS repository]
496+
497+
[[module-stream]]
498+
==== image:images/yes.png[yes] module stream (noun)
499+
*Description*: In Red Hat Enterprise Linux, _module streams_ are filters that can be thought of as virtual repositories in the AppStream physical repository. Module streams represent versions of the Application Stream components.
500+
501+
*Use it*: yes
502+
503+
*Incorrect forms*:
504+
505+
*See also*:
506+
477507
// RHV: Added "In Red Hat Virtualization,"
478508
[[mom]]
479509
==== image:images/yes.png[yes] MOM (noun)

supplementary_style_guide/glossary_terms_conventions/general_conventions/n.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,16 @@
6363

6464
*See also*: xref:management-cli[management CLI]
6565

66+
[[natively-compiled-code]]
67+
==== image:images/yes.png[yes] natively compiled code (noun)
68+
*Description*: _Natively compiled code_ is code written in a programming language that compiles to machine code with a resulting binary executable file. Such code can be run standalone.
69+
70+
*Use it*: yes
71+
72+
*Incorrect forms*: natively-compiled code
73+
74+
*See also*:
75+
6676
[[need]]
6777
==== image:images/yes.png[yes] need (verb)
6878
*Description*: Use "need" instead of "desire" or "wish". Use "want" when the reader's actions are optional; that is, one might not need something but might still want something.

supplementary_style_guide/glossary_terms_conventions/general_conventions/r.adoc

+42-12
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@
6363

6464
[[raw-data]]
6565
==== image:images/yes.png[yes] raw data (noun)
66-
6766
*Description*: _Raw data_ is information that has not been organized, formatted, or analyzed.
6867

6968
*Use it*: yes
@@ -72,6 +71,17 @@
7271

7372
*See also*:
7473

74+
[[raw-interpreted-program]]
75+
==== image:images/yes.png[yes] raw-interpreted program (noun)
76+
77+
*Description*: A _Raw-interpreted program_ is a program that does not need to be compiled and is directly run by a language interpreter.
78+
79+
*Use it*: yes
80+
81+
*Incorrect forms*:
82+
83+
*See also*: xref:interpreted-code[interpreted code]
84+
7585
// Ceph: Added "In Red Hat Ceph Storage, RBD is an"
7686
[[RBD]]
7787
==== image:images/yes.png[yes] RBD (noun)
@@ -407,16 +417,6 @@ Always use the approved product name _Red Hat build of OpenJDK_ instead.
407417

408418
*See also*: xref:red-hat-network-proxy-server[Red Hat Network Proxy Server]
409419

410-
[[red-hat-network-proxy-server]]
411-
==== image:images/yes.png[yes] Red Hat Network Proxy Server (noun)
412-
*Description*: Use "Red Hat Network Proxy Server" for the first occurrence; use "RHN Proxy Server" or omit the word "Server" from any of the previous constructions on subsequent mentions. With sufficient context, you can refer to "Satellite" and "Proxy", for example, "RHN Satellite and Proxy" instead of "RHN Satellite and RHN Proxy".
413-
414-
*Use it*: yes
415-
416-
*Incorrect forms*: Red Hat Proxy (Server)
417-
418-
*See also*: xref:red-hat-network-satellite-server[Red Hat Network Satellite Server]
419-
420420
[[red-hat-openjdk]]
421421
==== image:images/no.png[no] Red Hat OpenJDK (noun)
422422
*Description*: Do not use _Red Hat OpenJDK_ to refer to the Red Hat distribution of the Open Java Development Kit (OpenJDK).
@@ -431,6 +431,16 @@ Always use the approved product name _Red Hat build of OpenJDK_ instead.
431431

432432
*See also*: xref:red-hat-build-openjdk[Red Hat build of OpenJDK], xref:red-hat-java[Red Hat Java]
433433

434+
[[red-hat-network-proxy-server]]
435+
==== image:images/yes.png[yes] Red Hat Network Proxy Server (noun)
436+
*Description*: Use "Red Hat Network Proxy Server" for the first occurrence; use "RHN Proxy Server" or omit the word "Server" from any of the previous constructions on subsequent mentions. With sufficient context, you can refer to "Satellite" and "Proxy", for example, "RHN Satellite and Proxy" instead of "RHN Satellite and RHN Proxy".
437+
438+
*Use it*: yes
439+
440+
*Incorrect forms*: Red Hat Proxy (Server)
441+
442+
*See also*: xref:red-hat-network-satellite-server[Red Hat Network Satellite Server]
443+
434444
// OCP: General; kept as is
435445
[[red-hat-openshift-cluster-manager]]
436446
==== image:images/yes.png[yes] Red Hat OpenShift Cluster Manager (noun)
@@ -839,6 +849,16 @@ Use the name of the tab when you refer to it, for example, "the *Storage* tab".
839849

840850
*See also*:
841851

852+
[[rolling-stream]]
853+
==== image:images/yes.png[yes] Rolling Stream (noun)
854+
*Description*: _Rolling Streams_, also referred to as Rolling Application Streams, include Red Hat Enterprise Linux tools and applications that are updated frequently. Later versions of these streams replace earlier versions. Therefore, only one version at a time is supported.
855+
856+
*Use it*: yes
857+
858+
*Incorrect forms*: rolling stream
859+
860+
*See also*:
861+
842862
[[roll-out]]
843863
==== image:images/yes.png[yes] roll out (verb)
844864
*Description*: In marketing, to _roll out_ a product means to introduce it in stages to the public. In computing, to roll out software means to install a new product across a network.
@@ -997,14 +1017,24 @@ Use the name of the tab when you refer to it, for example, "the *Storage* tab".
9971017

9981018
[[rpm]]
9991019
==== image:images/yes.png[yes] RPM (noun)
1000-
*Description*: _RPM_ is the recursive initialism for the _RPM Package Manager_. RPM manages files in the RPM format, known as RPM packages. RPM packages are known informally as `rpm` files, but this informal usage is not used in Red Hat documentation to avoid confusion with the command name. Files in RPM format are referred to as "RPM packages".
1020+
*Description*: _RPM_ is the recursive initialism for the _RPM Package Manager_. RPM manages files in the RPM format. Those files are referred to as "RPM packages". Even though RPM packages are known informally as `rpm` files, do not use this informal term in Red Hat documentation to avoid confusion with the command name.
10011021

10021022
*Use it*: yes
10031023

10041024
*Incorrect forms*: rpm
10051025

10061026
*See also*:
10071027

1028+
[[rpm-macro]]
1029+
==== image:images/yes.png[yes] RPM macro (noun)
1030+
*Description*: An _RPM macro_ is a straight text substitution that can be conditionally assigned based on the optional evaluation of a statement when certain built-in functionality is used. RPM macros help to make package maintenance simpler and to automate certain repetitive tasks or patterns that are common across all types of packages.
1031+
1032+
*Use it*: yes
1033+
1034+
*Incorrect forms*:
1035+
1036+
*See also*:
1037+
10081038
// RHEL: General; kept as is
10091039
[[rpm-ostree]]
10101040
==== image:images/yes.png[yes] rpm-ostree (noun)

0 commit comments

Comments
 (0)