From c538398bff1c6b1a2ff2695e328ed08c83561eb6 Mon Sep 17 00:00:00 2001 From: Erin Donehoo Date: Thu, 12 Oct 2023 16:29:02 -0400 Subject: [PATCH 1/3] docs(terminology): Updates n/a and -- descriptions for clarity. --- .../content/design-guidelines/content/terminology.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md index de1e8d13ba..890a85b6e2 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md @@ -76,7 +76,7 @@ Use abbreviations that users are familiar with, and write out uncommon abbreviat | **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 data does not currently apply to the object and will not populate.

This includes scenarios where there is no matching data in the object's data source. For example, when nothing matches a filter, when the data source is empty, or when the object is not connected to any data source.| -| **--** | Refers to *data not available*, meaning data could apply to the object, but is currently not populating.

This includes scenarios where the object is connected to a data source, but is not able to fetch data. For example, when there are permission restrictions or errors.| +| **N/A** | Refers to *data not applicable*, meaning data is not relevant or does not currently apply to the object.

This includes scenarios where there is no matching data in the object's data source. For example, when nothing matches a filter, when the data source is empty, or when the object is not connected to any data source.| +| **--** | Refers to *data not available*, meaning data could apply to the object, but is currently not accessible and cannot be obtained at the moment.

This includes scenarios where the object is connected to a data source, but is not able to fetch data. For example, when there are permission restrictions or errors.| \ No newline at end of file From c2bdfcdc1a1bafec862ef49f9519f8ff30dfa008 Mon Sep 17 00:00:00 2001 From: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> Date: Fri, 27 Oct 2023 16:28:32 -0400 Subject: [PATCH 2/3] Update packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md --- .../content/design-guidelines/content/terminology.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md index 890a85b6e2..f0d765d868 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md @@ -77,6 +77,6 @@ Use abbreviations that users are familiar with, and write out uncommon abbreviat | **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 data is not relevant or does not currently apply to the object.

This includes scenarios where there is no matching data in the object's data source. For example, when nothing matches a filter, when the data source is empty, or when the object is not connected to any data source.| -| **--** | Refers to *data not available*, meaning data could apply to the object, but is currently not accessible and cannot be obtained at the moment.

This includes scenarios where the object is connected to a data source, but is not able to fetch data. For example, when there are permission restrictions or errors.| +| **--** | 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 f4d612e05a152c81ff4da920cf73671034f445ef Mon Sep 17 00:00:00 2001 From: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> Date: Fri, 27 Oct 2023 16:28:37 -0400 Subject: [PATCH 3/3] Update packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md --- .../content/design-guidelines/content/terminology.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md index f0d765d868..b10413306b 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/terminology.md @@ -76,7 +76,7 @@ Use abbreviations that users are familiar with, and write out uncommon abbreviat | **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 data is not relevant or does not currently apply to the object.

This includes scenarios where there is no matching data in the object's data source. For example, when nothing matches a filter, when the data source is empty, or when the object is not connected to any data source.| +| **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