From ed926e0f2ccde4fb8c310a35dec24eee4262da31 Mon Sep 17 00:00:00 2001 From: Travis Martin Date: Wed, 21 May 2025 10:41:12 -0700 Subject: [PATCH 1/2] style guide: added "disconnected" as preferred term --- templates/style-guide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/templates/style-guide.md b/templates/style-guide.md index d97e06a98..246435f5d 100644 --- a/templates/style-guide.md +++ b/templates/style-guide.md @@ -107,6 +107,7 @@ The table provides guidelines about the terms you should and should not use for | data source | | | | database | Do not abbreviate as "db". Always a single word. | | |date format | Use _month day, year_ format, as in December 4, 2024. Don't use _day month year_, as in 31 July 2016.
In the UI, it's OK to use numbers and slashes for dates if the code supports that format and automatically displays the appropriate date format for different locales. For example, 12/4/2024. | This format aligns with standard American usage for consistency and clarity. | +| disconnected | Use this term to describe environments without internet or external network access, such as air-gapped, offline, or network-restricted setups. Preferred term due to alignment with product UI and configuration settings (e.g., `mode_of_operation: disconnected`). If needed, clarify as "in a disconnected (network-restricted) environment" for context. | | | DoS/DDoS/3DoS | Spell out on first reference:
- denial-of-service (DoS)
- distributed denial-of-service (DDoS)
- diverse distributed denial-of-service (3DoS) | | | e.g., i.e., etc. | Avoid using Latin abbreviations.
- e.g. = for example
- i.e. = in other words
- etc. = and so on | | | earlier and later | Use to describe versioning. For example, "This applies to versions earlier than NGINX Plus R31".
Do not use before, after, greater, lower, higher, below, above, and so on. | | From f3c99320cab0c398c7143dfde775f80ffaca0165 Mon Sep 17 00:00:00 2001 From: Travis Martin Date: Wed, 21 May 2025 10:45:53 -0700 Subject: [PATCH 2/2] edits --- templates/style-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/style-guide.md b/templates/style-guide.md index 246435f5d..4959228fd 100644 --- a/templates/style-guide.md +++ b/templates/style-guide.md @@ -107,7 +107,7 @@ The table provides guidelines about the terms you should and should not use for | data source | | | | database | Do not abbreviate as "db". Always a single word. | | |date format | Use _month day, year_ format, as in December 4, 2024. Don't use _day month year_, as in 31 July 2016.
In the UI, it's OK to use numbers and slashes for dates if the code supports that format and automatically displays the appropriate date format for different locales. For example, 12/4/2024. | This format aligns with standard American usage for consistency and clarity. | -| disconnected | Use this term to describe environments without internet or external network access, such as air-gapped, offline, or network-restricted setups. Preferred term due to alignment with product UI and configuration settings (e.g., `mode_of_operation: disconnected`). If needed, clarify as "in a disconnected (network-restricted) environment" for context. | | +| disconnected | Use this term to describe environments without internet or external network access, such as air-gapped, offline, or network-restricted setups. Preferred term due to alignment with product UI and configuration settings (for example, `mode_of_operation: disconnected`). If needed, clarify as "in a disconnected (network-restricted) environment" for context. | | | DoS/DDoS/3DoS | Spell out on first reference:
- denial-of-service (DoS)
- distributed denial-of-service (DDoS)
- diverse distributed denial-of-service (3DoS) | | | e.g., i.e., etc. | Avoid using Latin abbreviations.
- e.g. = for example
- i.e. = in other words
- etc. = and so on | | | earlier and later | Use to describe versioning. For example, "This applies to versions earlier than NGINX Plus R31".
Do not use before, after, greater, lower, higher, below, above, and so on. | |