From d2da24ddd20d5f71b123d1c61c77948ca3ad9041 Mon Sep 17 00:00:00 2001 From: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> Date: Fri, 13 Feb 2026 16:22:39 -0500 Subject: [PATCH 1/3] docs(terminology): Add related icons to table. --- .../content-design/grammar/terminology.md | 119 ++++++++++-------- 1 file changed, 70 insertions(+), 49 deletions(-) diff --git a/packages/documentation-site/patternfly-docs/content/content-design/grammar/terminology.md b/packages/documentation-site/patternfly-docs/content/content-design/grammar/terminology.md index e4d0bd8d0c..bcb457e60a 100644 --- a/packages/documentation-site/patternfly-docs/content/content-design/grammar/terminology.md +++ b/packages/documentation-site/patternfly-docs/content/content-design/grammar/terminology.md @@ -4,6 +4,27 @@ section: content-design subsection: grammar --- +import PlusIcon from '@patternfly/react-icons/dist/esm/icons/plus-icon'; +import AddCircleOIcon from '@patternfly/react-icons/dist/esm/icons/add-circle-o-icon'; +import TimesIcon from '@patternfly/react-icons/dist/esm/icons/times-icon'; +import TimesCircleIcon from '@patternfly/react-icons/dist/esm/icons/times-circle-icon'; +import AngleDownIcon from '@patternfly/react-icons/dist/esm/icons/angle-down-icon'; +import AngleUpIcon from '@patternfly/react-icons/dist/esm/icons/angle-up-icon'; +import AngleRightIcon from '@patternfly/react-icons/dist/esm/icons/angle-right-icon'; +import CopyIcon from '@patternfly/react-icons/dist/esm/icons/copy-icon'; +import TrashIcon from '@patternfly/react-icons/dist/esm/icons/trash-icon'; +import DownloadIcon from '@patternfly/react-icons/dist/esm/icons/download-icon'; +import PencilAltIcon from '@patternfly/react-icons/dist/esm/icons/pencil-alt-icon'; +import ExportIcon from '@patternfly/react-icons/dist/esm/icons/export-icon'; +import FilterIcon from '@patternfly/react-icons/dist/esm/icons/filter-icon'; +import ImportIcon from '@patternfly/react-icons/dist/esm/icons/import-icon'; +import MinusIcon from '@patternfly/react-icons/dist/esm/icons/minus-icon'; +import MinusCircleIcon from '@patternfly/react-icons/dist/esm/icons/minus-circle-icon'; +import SaveIcon from '@patternfly/react-icons/dist/esm/icons/save-icon'; +import SearchIcon from '@patternfly/react-icons/dist/esm/icons/search-icon'; +import EyeIcon from '@patternfly/react-icons/dist/esm/icons/eye-icon'; +import UploadIcon from '@patternfly/react-icons/dist/esm/icons/upload-icon'; + This resource overviews common UI terms and their usage. Do not precede any terms in a UI with "please" as it is extraneous and overly formal. For Red Hat product terminology and documentation standards, see [Red Hat's supplementary style guide for product documentation](https://redhat-documentation.github.io/supplementary-style-guide/#introduction). @@ -24,57 +45,57 @@ When using trademarks: | Before | After | | :---: | :---: | -| Why settle for VMware’s slow boot times? Our platform is 20% faster and costs half as much as their legacy junk. | In independent benchmarks, Red Hat OpenShift demonstrated 20% faster deployment times compared to VMware vSphere. Our solution offers a verifiable cost-efficiency advantage for enterprise-scale workloads.| +| Why settle for VMware's slow boot times? Our platform is 20% faster and costs half as much as their legacy junk. | In independent benchmarks, Red Hat OpenShift demonstrated 20% faster deployment times compared to VMware vSphere. Our solution offers a verifiable cost-efficiency advantage for enterprise-scale workloads.| ## Glossary
-| **Term** | **Usage** | **Opposite term** | **Notes** | -|------------------|-----------|-----|-----| -| **Add** (v.) | Use to describe adding an existing item to an existing list, group, view, or other container element. | *Remove* | If the object being added is not readily apparent from the context, consider adding a noun (like “Add user”). If you’re creating a new object, **do not use** *Add*. See *Create*. -| **Cancel** (v.) | Use to describe ending an action in progress or ending an action where changes could be lost (like in a form). | | Use *Canceling* instead of *Cancelling*. Use *Canceled* instead of *Cancelled*.| -| **Change** | **Do not use**. See *Edit*. -| **Click** (v.) | Use to prompt the user to click a button, radio button, link, or any other item that isn't part of a list, group, view, or other container element.| | **Do not use** interchangeably with *Select*.| -| **Close** (v.) | Use to describe shutting an open window (like a message dialog). | *Open* | **Do not use** interchangeably with *Cancel* or *Quit*. | -| **Collapse** (v.)| Use to describe minimizing a container element (like a list or message) so that it’s partially visible. | *Expand* | -| **Continue** (v.) | Use to describe proceeding with an action or process that is in progress. | -| **Copy** (v.) | Use to describe the action of creating a reproduction of an object (like a file or text). This may be used in reference to the keyboard action (Ctrl/cmd + c). | | Do not use interchangeably with *Duplicate*. -| **Create** (v.) | Use to describe creating something new. | *Delete* | If the object being created is not readily apparent from the context, consider adding a noun (like “Create user”). *New* or *Add* are not recommended for this use case. See *Add* for usage guidelines. -| **Delete** (v.) | Use to describe completely removing an object. Delete is a destructive action. | *Create* | *Erase* and *Remove* are not recommended for this use case. See *Remove* for usage guidelines. -| **Deselect** (v.) | Use to prompt the user to deselect an item from a list, group, view, or other container element. | *Select* -| **Download** (v.) | Use to describe copying a file from a server or site directly to your system in a file format. | *Upload* | -| **Duplicate** (v.) |Use to describe creating a copy of an object (like a file or configuration). The duplicate item may be edited upon or after creation. | | Do not use interchangeably with *Copy*. -| **Edit** (v.) | Use to describe making changes to an object (like a file, configuration, or policy). | | *Modify* and *Change* are not recommended for this use case.| -| **Expand** (v.) | Use to describe expanding a container element (like a list or message) to show all its contents. | *Collapse* -| **Export** (v.) | Use to describe packing the contents (like a project or spreadsheet) from a website or application to a file format (like .pdf or .xslx) to your system. | *Import* | Do not use interchangeably with *Download*. -| **Export** (v.) | Use to describe packing the contents (like a project or spreadsheet) from a website or application to a file format (like .pdf or .xslx) to your system. | *Import* | Do not use interchangeably with *Download*. -| **Filter** (v.) | Use to describe the action of narrowing a set of search results to show only items meeting a certain criteria. Filtering is mostly associated with views like tables, lists, and card grids and assumes that a search has previously been performed to return an initial results list. -| **Hide** (v.) | Use to describe hiding something that is displayed in the interface. | *Show* -| **Home page** (n.) | Use to describe the main page of a website. | | Write *Home page* as two words, not one. -| **Import** (v.) |Use to describe loading a copy of an object (like a file, image, or format) to your system, software, or application for use or processing. | *Export* | Do not use interchangeably with *Upload* or *Add*. -| **Log in** (v.) | Use to describe logging in. | *Log out *| Use *log in to,* not *log into.* -| **Login** (adj.) | Use to describe something related to the act of logging in to an application, like a login page. | | The noun *Login* can also be used as an alternative for *Username*, but *Username* is recommended. | -| **Log out** (v.) | Use to describe logging out. | *Log in* -| **Modify** | **Do not use.** See *Edit*. -| **New** | **Do not use.** See *Add* or *Create*. -| **OK** (adj.) | Use to collect confirmation or understanding from the user. | | Do not use *Okay,* *O.K.,* *Ok,* or *ok* in the UI. -| **Open** (v.) | Use to describe launching something (like system preferences).| *Close* -| **Quit** (v.) | Use to describe exiting an application. -| **Please** (adv.) | **Do not use** | Do not precede UI terms with "please". It is extraneous and overly formal. | -| **Remove** (v.) | Use to describe removing an item from a list, group, view, or other container element without completely deleting it. Also see *Add* and *Delete*. | *Add* | If what you’re removing is not readily apparent from the context, consider adding a noun (like “Remove file”). -| **Save** (v.) | Use to describe preserving changes made by the user. | *Cancel* -| **Search** (v.) | Use to decribe the action of querying a data set to return a results list. Searching will always be applied against some criteria and may be narrow or broad. -| **Select** (v.) | Use to prompt the user to select an item from a list, group, view, or other container element. | *Deselect* | Do not use *Choose* for this use case. -| **Set up** (v.) | Use to describe setting up an arrangement (like a system, process, or environment). | | *Set up* is two words as a verb and one word as a noun. See *Setup*. -| **Setup** (n.) | Use to describe the setup of something (like a system, process, or environment). | | *Setup* is one word as a noun and two words as a verb. See *Set up*. -| **Show** (v.) | Use to describe displaying something that is hidden in the interface. | *Hide* | Do not use interchangeably with *View* or *Expand*. -| **Sign up** (v.) | Use to describe signing up for a web account, application, service, or event. | | *Sign up* is two words as a verb and one word as an adjective or noun. See *Signup*. -| **Signup** (adj.) | Use to describe something related to the act of signing up for a web account, application, service, or event, like a signup page. | | The noun *Signup* can also be used to refer to a user signup submission (for example, "We need more signups for this event."). -| **View** (v.) | Use to describe accessing another page to see details. (n.) Use to represent an arrangement of data in the interface (like a list view). | | Do not use interchangeably with *Show* or *Expand*. -| **Upload** (v.) | Use to describe loading a copy of a file to a server.| | Do not use interchangeably with *Import*. -| **Username** (n.) | Usually a unique ID (like ssmith123). -| **Utilize** (v.) | **Do not use.** Opt for the less formal version, *Use*. +| **Term** | **Usage** | **Related icon** | **Opposite term** | **Notes** | +|------------------|-----------|-----|-----|-----| +| **Add**
(verb) | Use to describe adding an existing item to an existing list, group, view, or other container element. |
(fa-plus) | *Remove* | If the object being added is not readily apparent from the context, consider adding a noun (like "Add user"). If you're creating a new object, **do not use** *Add*. See *Create*. +| **Cancel**
(verb) | Use to describe ending an action in progress or ending an action where changes could be lost (like in a form). | | | Use *Canceling* instead of *Cancelling*. Use *Canceled* instead of *Cancelled*.| +| **Change** | **Do not use**. See *Edit*. | | | +| **Click**
(verb) | Use to prompt the user to click a button, radio button, link, or any other item that isn't part of a list, group, view, or other container element.| | | **Do not use** interchangeably with *Select*.| +| **Close**
(verb) | Use to describe shutting an open window (like a message dialog). |
(fa-times)


(fa-times-circle) | *Open* | **Do not use** interchangeably with *Cancel* or *Quit*. | +| **Collapse**
(verb) | Use to describe minimizing a container element (like a list or message) so that it's partially visible. |
(fa-angle-down)


(fa-angle-up) | *Expand* | +| **Continue**
(verb) | Use to describe proceeding with an action or process that is in progress. | | | +| **Copy**
(verb) | Use to describe the action of creating a reproduction of an object (like a file or text). This may be used in reference to the keyboard action (Ctrl/cmd + c). |
(fa-copy) | | **Do not use** interchangeably with *Duplicate*. +| **Create**
(verb) | Use to describe creating something new. |
(pficon-add-circle-o) | *Delete* | If the object being created is not readily apparent from the context, consider adding a noun (like "Create user"). *New* or *Add* are not recommended for this use case. See *Add* for usage guidelines. +| **Delete**
(verb) | Use to describe completely removing an object. Delete is a destructive action. |
(fa-trash) | *Create* | *Erase* and *Remove* are not recommended for this use case. See *Remove* for usage guidelines. +| **Deselect**
(verb) | Use to prompt the user to deselect an item from a list, group, view, or other container element. | | *Select* | +| **Download**
(verb) | Use to describe copying a file from a server or site directly to your system in a file format. |
(fa-download) | *Upload* | +| **Duplicate**
(verb) | Use to describe creating a copy of an object (like a file or configuration). The duplicate item may be edited upon or after creation. | | | **Do not use** interchangeably with *Copy*. +| **Edit**
(verb) | Use to describe making changes to an object (like a file, configuration, or policy). |
(fa-pencil-alt) | | *Modify* and *Change* are not recommended for this use case.| +| **Expand**
(verb) | Use to describe expanding a container element (like a list or message) to show all its contents. |
(fa-angle-right) | *Collapse* | +| **Export**
(verb) | Use to describe packing the contents (like a project or spreadsheet) from a website or application to a file format (like .pdf or .xslx) to your system. |
(pficon-export) | *Import* | **Do not use** interchangeably with *Download*. +| **Export**
(verb) | Use to describe packing the contents (like a project or spreadsheet) from a website or application to a file format (like .pdf or .xslx) to your system. |
(pficon-export) | *Import* | **Do not use** interchangeably with *Download*. +| **Filter**
(verb) | Use to describe the action of narrowing a set of search results to show only items meeting a certain criteria. Filtering is mostly associated with views like tables, lists, and card grids and assumes that a search has previously been performed to return an initial results list. |
(fa-filter) | | +| **Hide**
(verb) | Use to describe hiding something that is displayed in the interface. | | *Show* | +| **Home page**
(noun) | Use to describe the main page of a website. | | | Write *Home page* as two words, not one. +| **Import**
(verb) | Use to describe loading a copy of an object (like a file, image, or format) to your system, software, or application for use or processing. |
(pficon-import) | *Export* | **Do not use** interchangeably with *Upload* or *Add*. +| **Log in**
(verb) | Use to describe logging in. | | *Log out *| Use *log in to,* not *log into.* +| **Login**
(adjective) | Use to describe something related to the act of logging in to an application, like a login page. | | | The noun *Login* can also be used as an alternative for *Username*, but *Username* is recommended. | +| **Log out**
(verb) | Use to describe logging out. | | *Log in* | +| **Modify** | **Do not use.** See *Edit*. | | | +| **New** | **Do not use.** See *Add* or *Create*. | | | +| **OK**
(adjective) | Use to collect confirmation or understanding from the user. | | | **Do not use** *Okay,* *O.K.,* *Ok,* or *ok* in the UI. +| **Open**
(verb) | Use to describe launching something (like system preferences).| | *Close* | +| **Quit**
(verb) | Use to describe exiting an application. | | | +| **Please**
(adverb) | **Do not use** | | | Do not precede UI terms with "please". It is extraneous and overly formal. | +| **Remove**
(verb) | Use to describe removing an item from a list, group, view, or other container element without completely deleting it. Also see *Add* and *Delete*. |
(fa-minus)


(fa-minus-circle) | *Add* | If what you're removing is not readily apparent from the context, consider adding a noun (like "Remove file"). +| **Save**
(verb) | Use to describe preserving changes made by the user. |
(pficon-save) | *Cancel* | +| **Search**
(verb) | Use to describe the action of querying a data set to return a results list. Searching will always be applied against some criteria and may be narrow or broad. |
(fa-search) | | +| **Select**
(verb) | Use to prompt the user to select an item from a list, group, view, or other container element. | | *Deselect* | **Do not use** *Choose* for this use case. +| **Set up**
(verb) | Use to describe setting up an arrangement (like a system, process, or environment). | | | *Set up* is two words as a verb and one word as a noun. See *Setup*. +| **Setup**
(noun) | Use to describe the setup of something (like a system, process, or environment). | | | *Setup* is one word as a noun and two words as a verb. See *Set up*. +| **Show**
(verb) | Use to describe displaying something that is hidden in the interface. |
(fa-eye) | *Hide* | **Do not use** interchangeably with *View* or *Expand*. +| **Sign up**
(verb) | Use to describe signing up for a web account, application, service, or event. | | | *Sign up* is two words as a verb and one word as an adjective or noun. See *Signup*. +| **Signup**
(adjective) | Use to describe something related to the act of signing up for a web account, application, service, or event, like a signup page. | | | The noun *Signup* can also be used to refer to a user signup submission (for example, "We need more signups for this event."). +| **View**
(verb) | Use to describe accessing another page to see details. (n.) Use to represent an arrangement of data in the interface (like a list view). | | | **Do not use** interchangeably with *Show* or *Expand*. +| **Upload**
(verb) | Use to describe loading a copy of a file to a server.|
(fa-upload) | | Do not use interchangeably with *Import*. +| **Username**
(noun) | Usually a unique ID (like ssmith123). | | | +| **Utilize**
(verb) | **Do not use.** Opt for the less formal version, *Use*. | | |
@@ -86,16 +107,16 @@ Use abbreviations that users are familiar with, and write out uncommon abbreviat | **Abbreviation** | **Usage** | |------------------|-----------| | **CSS** | Stands for *Cascading Style Sheets*. Write *CSS* in all caps. | -| **e.g.**, **i.e.**, and **etc.** | Use sparingly. These terms aren’t easily understood by everyone, especially users whose native language is not rooted in Latin. Write out their meaning instead: | +| **e.g.**, **i.e.**, and **etc.** | Use sparingly. These terms aren't easily understood by everyone, especially users whose native language is not rooted in Latin. Write out their meaning instead: | | **HTML** | Stands for *Hypertext Markup Language*. Write *HTML* in all caps. | | **JS** | Stands for *JavaScript*. Write *JS* in all caps. | | **K8** | Stands for *Kubernetes*. | | **KVM** | Refers to a kernel-based virtual machine. Write *KVM* in all caps. | -| **sysadmin** | Avoid using abbreviations like *sysadmin* and *SysAdmin* because they’re too informal and not always easily understood. *System* should be singular (not *Systems administrator*) because it can include both a single system and multiple systems, similar to a *brain surgeon*, who works on more than one brain.

Taken from Red Hat Corporate Style Guide. | +| **sysadmin** | Avoid using abbreviations like *sysadmin* and *SysAdmin* because they're too informal and not always easily understood. *System* should be singular (not *Systems administrator*) because it can include both a single system and multiple systems, similar to a *brain surgeon*, who works on more than one brain.

Taken from Red Hat Corporate Style Guide. | | **U.S.** | As a noun, use *United States* unless there are space constraints. As an adjective, use *U.S.* (for example, *U.S. soldier*). As part of an organization, use *U.S.*

Taken from Red Hat Corporate Style Guide. | | **URL** | Stands for *Uniform Resource Locator*. Write *URL* in all caps. | | **VM** | Refers to a virtual machine. OK to abbreviate as long as you've spelled it out once in the first occurrence and as long as *VM* won't be confused with other terms that share that acronym.

Taken from Red Hat Corporate Style Guide. | | **N/A** | Refers to *data not applicable*, meaning there is no relevant, matching, or applicable data.

For example, when a filter returns no results, when a data source is empty, or when no data source is connected.| | **--** | Refers to *data unavailable*, meaning the data exists and fits the criteria, but is not currently available to display.

For example, when a data source is connected, but data can't be fetched due to permission restrictions or errors.| - \ No newline at end of file + From 26495f682c4ef5e4d6b8eaec13976192e4551261 Mon Sep 17 00:00:00 2001 From: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> Date: Fri, 13 Feb 2026 16:22:57 -0500 Subject: [PATCH 2/3] Update column header. --- .../content/content-design/grammar/terminology.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/content-design/grammar/terminology.md b/packages/documentation-site/patternfly-docs/content/content-design/grammar/terminology.md index bcb457e60a..0842500f59 100644 --- a/packages/documentation-site/patternfly-docs/content/content-design/grammar/terminology.md +++ b/packages/documentation-site/patternfly-docs/content/content-design/grammar/terminology.md @@ -51,7 +51,7 @@ When using trademarks:
-| **Term** | **Usage** | **Related icon** | **Opposite term** | **Notes** | +| **Term** | **Usage** | **Related icons** | **Opposite term** | **Notes** | |------------------|-----------|-----|-----|-----| | **Add**
(verb) | Use to describe adding an existing item to an existing list, group, view, or other container element. |
(fa-plus) | *Remove* | If the object being added is not readily apparent from the context, consider adding a noun (like "Add user"). If you're creating a new object, **do not use** *Add*. See *Create*. | **Cancel**
(verb) | Use to describe ending an action in progress or ending an action where changes could be lost (like in a form). | | | Use *Canceling* instead of *Cancelling*. Use *Canceled* instead of *Cancelled*.| From 9e2d49d97e098a5817b344073887f81eba14fe12 Mon Sep 17 00:00:00 2001 From: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> Date: Mon, 16 Feb 2026 10:07:14 -0500 Subject: [PATCH 3/3] Add hide icon --- .../content/content-design/grammar/terminology.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/content-design/grammar/terminology.md b/packages/documentation-site/patternfly-docs/content/content-design/grammar/terminology.md index 0842500f59..656dc392ea 100644 --- a/packages/documentation-site/patternfly-docs/content/content-design/grammar/terminology.md +++ b/packages/documentation-site/patternfly-docs/content/content-design/grammar/terminology.md @@ -23,6 +23,7 @@ import MinusCircleIcon from '@patternfly/react-icons/dist/esm/icons/minus-circle import SaveIcon from '@patternfly/react-icons/dist/esm/icons/save-icon'; import SearchIcon from '@patternfly/react-icons/dist/esm/icons/search-icon'; import EyeIcon from '@patternfly/react-icons/dist/esm/icons/eye-icon'; +import EyeSlashIcon from '@patternfly/react-icons/dist/esm/icons/eye-slash-icon'; import UploadIcon from '@patternfly/react-icons/dist/esm/icons/upload-icon'; This resource overviews common UI terms and their usage. Do not precede any terms in a UI with "please" as it is extraneous and overly formal. @@ -71,7 +72,7 @@ When using trademarks: | **Export**
(verb) | Use to describe packing the contents (like a project or spreadsheet) from a website or application to a file format (like .pdf or .xslx) to your system. |
(pficon-export) | *Import* | **Do not use** interchangeably with *Download*. | **Export**
(verb) | Use to describe packing the contents (like a project or spreadsheet) from a website or application to a file format (like .pdf or .xslx) to your system. |
(pficon-export) | *Import* | **Do not use** interchangeably with *Download*. | **Filter**
(verb) | Use to describe the action of narrowing a set of search results to show only items meeting a certain criteria. Filtering is mostly associated with views like tables, lists, and card grids and assumes that a search has previously been performed to return an initial results list. |
(fa-filter) | | -| **Hide**
(verb) | Use to describe hiding something that is displayed in the interface. | | *Show* | +| **Hide**
(verb) | Use to describe hiding something that is displayed in the interface. |
(fa-eye-slash) | *Show* | | **Home page**
(noun) | Use to describe the main page of a website. | | | Write *Home page* as two words, not one. | **Import**
(verb) | Use to describe loading a copy of an object (like a file, image, or format) to your system, software, or application for use or processing. |
(pficon-import) | *Export* | **Do not use** interchangeably with *Upload* or *Add*. | **Log in**
(verb) | Use to describe logging in. | | *Log out *| Use *log in to,* not *log into.*