Skip to content

style guide: added "disconnected" as preferred term #582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 23, 2025

Conversation

travisamartin
Copy link
Contributor

Summary

Add a new glossary entry for "disconnected" to the NGINX documentation style guide.

Background

To ensure consistency across documentation, UX, and product configuration, we're standardizing on the term "disconnected" to describe environments without internet or external network access. This aligns with the mode_of_operation: disconnected setting in NGINX Instance Manager.

Terms like "air-gapped", "offline", "network-restricted", and "dark site" have been used inconsistently. Standardizing terminology helps avoid confusion and better reflects actual usage in the product UI and configuration files.

Changes

  • Added a new row to the glossary:

    | 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. | |

@travisamartin travisamartin requested a review from a team as a code owner May 21, 2025 17:43
@github-actions github-actions bot added the process documentation Documentation related to how the repository or documention itself is managed. label May 21, 2025
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/582/

Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: are we still updating the "revision history" at the bottom of this file? (I'm OK if we want to make this an "open question" that we answer later.)

Maybe: git blame is "good enough"?

@ADubhlaoich ADubhlaoich merged commit 573f3cc into main May 23, 2025
8 checks passed
@ADubhlaoich ADubhlaoich deleted the style-disconnected-environment branch May 23, 2025 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
process documentation Documentation related to how the repository or documention itself is managed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants