docs: replace offline deployments terminology to air-gapped #19625

blink-so · 2025-08-28T16:36:32Z

This PR comprehensively updates the offline deployments documentation to use more precise "air-gapped" terminology and improves consistency throughout the documentation.

Changes Made

Terminology Updates

Title: Changed from "Offline Deployments" to "Air-gapped Deployments"
Summary: Updated to prioritize "air-gapped" terminology and added "disconnected" to cover additional deployment scenarios
Content: Updated tutorial references to use "air-gapped" instead of "offline"
Section headers:
- Changed "Offline container images" to "Air-gapped container images"
- Changed "Offline docs" to "Air-gapped docs"
Table headers: Changed "Offline deployments" to "Air-gapped deployments"

Navigation & URL Structure

Navigation title: Updated docs/manifest.json to show "Air-gapped Deployments" in sidebar
Navigation description: Updated to "Run Coder in air-gapped / disconnected / offline environments"
File rename: docs/install/offline.md → docs/install/airgap.md for consistency
URL change: /install/offline → /install/airgap
Subsection anchors:
- /install/offline#offline-docs → /install/airgap#airgap-docs
- /install/offline#offline-container-images → /install/airgap#airgap-container-images

Internal Links & References

Updated all internal documentation links:

docs/admin/integrations/index.md
docs/admin/networking/index.md
docs/changelogs/v0.27.0.md (including anchor reference)
docs/tutorials/faqs.md

Backward Compatibility

Redirects: Added docs/_redirects with 301 redirects:
- /install/offline → /install/airgap
- /install/offline#offline-docs → /install/airgap#airgap-docs
- /install/offline#offline-container-images → /install/airgap#airgap-container-images
Content: Maintains "offline" in the description for broader understanding
Deep links: All subsection anchors redirect properly to maintain existing bookmarks

Rationale

"Air-gapped" is more precise and commonly used in enterprise/security contexts
"Disconnected" covers additional scenarios where networks may be temporarily or partially isolated
Consistency ensures filename, URL, navigation, content, and subsection anchors all align with the same terminology
Backward compatibility maintained through comprehensive redirects to prevent broken links at any level

Testing

Verified all internal links point to the new URL structure
Confirmed navigation title updates correctly
Ensured content accuracy is maintained
Added redirects for backward compatibility (main page + subsections)
Updated all cross-references in related documentation
Verified subsection anchor redirects work properly
Confirmed no unnecessary .md file redirects

Result

Complete terminology consistency across:

✅ Page title and headers
✅ Navigation and breadcrumbs
✅ File names and URL structure
✅ Internal documentation links
✅ Table headers and section titles
✅ Subsection anchors and deep links
✅ Backward compatibility via comprehensive redirects

- Change title from 'Offline Deployments' to 'Air-gapped Deployments' - Update summary to prioritize 'air-gapped' and add 'disconnected' - Change table header from 'Offline deployments' to 'Air-gapped deployments' - Update tutorial reference to use 'air-gapped' terminology - Update section header to 'Air-gapped container images' This improves clarity by using the more precise 'air-gapped' terminology and includes 'disconnected' to cover additional deployment scenarios.

The markdown table formatter was removing trailing spaces from the 'Air-gapped deployments' column header, causing CI failures.

david-fraley · 2025-08-28T18:25:11Z

Confirmed with Ross W, and he’s aligned on this change.

- Update manifest.json to change navigation title from 'Offline Deployments' to 'Air-gapped Deployments' - Update description to prioritize 'air-gapped' terminology - Fix line break issues in the markdown file This ensures the navigation, breadcrumbs, and page title all consistently use 'Air-gapped Deployments'.

- Rename docs/install/offline.md to docs/install/airgap.md for consistency - Update manifest.json path to point to ./install/airgap.md - Update all internal links from install/offline to install/airgap - Add redirect configuration for /install/offline -> /install/airgap - Updated files: integrations/index.md, networking/index.md, changelogs/v0.27.0.md, faqs.md This ensures complete consistency with the new 'air-gapped' terminology while maintaining backward compatibility through redirects.

- Update 'Offline docs' section header to 'Air-gapped docs' - Add redirects for anchor fragments: - /install/offline#offline-docs -> /install/airgap#airgap-docs - /install/offline#offline-container-images -> /install/airgap#airgap-container-images - Update changelog reference to use new airgap-docs anchor This ensures complete URL consistency including subsection anchors while maintaining backward compatibility for deep links.

Removed /install/offline.md redirect as users don't typically access raw markdown files directly. Kept the essential redirects: - Main page: /install/offline -> /install/airgap - Subsection anchors for deep links

Changed 'offline documentation' to 'air-gapped documentation' in the Air-gapped docs section for complete terminology consistency.

matifali

Noticed a few missed mentions.

matifali · 2025-08-29T10:26:29Z

docs/admin/integrations/index.md

@@ -13,6 +13,6 @@ our [installation guides](../../install/index.md).
 The following resources may help as you're deploying Coder.

 - [Coder packages: one-click install on cloud providers](https://github.com/coder/packages)
- [Deploy Coder offline](../../install/offline.md)
+- [Deploy Coder offline](../../install/airgap.md)


Suggested change

- [Deploy Coder offline](../../install/airgap.md)

- [Deploy Coder Air-gapped](../../install/airgap.md)

✅ Fixed! Updated to "Deploy Coder Air-gapped" along with several other missed mentions I found throughout the docs.

matifali · 2025-08-29T10:26:46Z

docs/admin/networking/index.md

@@ -116,12 +116,12 @@ If a direct connection is not available (e.g. client or server is behind NAT),
 Coder will use a relayed connection. By default,
 [Coder uses Google's public STUN server](../../reference/cli/server.md#--derp-server-stun-addresses),
 but this can be disabled or changed for
-[offline deployments](../../install/offline.md).
+[offline deployments](../../install/airgap.md).


Suggested change

[offline deployments](../../install/airgap.md).

[Air-gapped deployments](../../install/airgap.md).

✅ Fixed! Updated to "Air-gapped deployments" here and found several other instances throughout the docs that needed the same update.

@matifali

Updated remaining instances to use 'air-gapped deployments' terminology: - integrations/index.md: 'Deploy Coder offline' -> 'Deploy Coder Air-gapped' - networking/index.md: Multiple 'offline deployments' -> 'Air-gapped deployments' - jfrog-artifactory.md: Section header and text updated - changelogs/v2.8.0.md: Changelog entry updated Thanks to @matifali for catching these missed references!

Fixed punctuation in the opening sentence of the air-gapped deployments page.

Fixes lint failure - files must end with a newline character.

github-actions · 2025-08-29T13:57:33Z

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

david-fraley · 2025-08-29T14:08:33Z

I have read the CLA Document and I hereby sign the CLA

blink-so bot added 2 commits August 28, 2025 16:36

fix: Remove trailing spaces from table header to fix formatting

c860aa6

The markdown table formatter was removing trailing spaces from the 'Air-gapped deployments' column header, causing CI failures.

david-fraley changed the title ~~docs: Update offline deployments terminology to air-gapped~~ docs: update offline deployments terminology to air-gapped Aug 28, 2025

david-fraley changed the title ~~docs: update offline deployments terminology to air-gapped~~ docs: replace offline deployments terminology to air-gapped Aug 28, 2025

david-fraley requested review from bpmct and matifali and removed request for bpmct August 28, 2025 18:19

bpmct approved these changes Aug 28, 2025

View reviewed changes

blink-so bot added 2 commits August 28, 2025 18:46

blink-so bot changed the title ~~docs: replace offline deployments terminology to air-gapped~~ docs: Update offline deployments terminology to air-gapped Aug 28, 2025

blink-so bot added 3 commits August 28, 2025 19:07

docs: Clean up redirects - remove unnecessary .md redirect

f4b962e

Removed /install/offline.md redirect as users don't typically access raw markdown files directly. Kept the essential redirects: - Main page: /install/offline -> /install/airgap - Subsection anchors for deep links

docs: Fix remaining 'offline documentation' reference

2b830a3

Changed 'offline documentation' to 'air-gapped documentation' in the Air-gapped docs section for complete terminology consistency.

matifali reviewed Aug 29, 2025

View reviewed changes

matifali assigned david-fraley Aug 29, 2025

blink-so bot added 3 commits August 29, 2025 10:29

docs: Add missing period after 'offline' in first sentence

3e0d496

Fixed punctuation in the opening sentence of the air-gapped deployments page.

docs: Add missing newline at end of changelog file

6c18600

Fixes lint failure - files must end with a newline character.

david-fraley changed the title ~~docs: Update offline deployments terminology to air-gapped~~ docs: replace offline deployments terminology to air-gapped Aug 29, 2025

david-fraley marked this pull request as ready for review August 29, 2025 13:57

Merge branch 'main' into blink/update-offline-docs-terminology

151d7cc

cdrci2 added a commit to coder/cla that referenced this pull request Aug 29, 2025

@david-fraley has signed the CLA in coder/coder#19625

d788a8c

matifali approved these changes Aug 29, 2025

View reviewed changes

david-fraley merged commit 02ecf32 into main Aug 29, 2025
32 of 33 checks passed

david-fraley deleted the blink/update-offline-docs-terminology branch August 29, 2025 14:34

github-actions bot locked and limited conversation to collaborators Aug 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: replace offline deployments terminology to air-gapped #19625

docs: replace offline deployments terminology to air-gapped #19625

Uh oh!

blink-so bot commented Aug 28, 2025 •

edited

Loading

Uh oh!

david-fraley commented Aug 28, 2025

Uh oh!

matifali left a comment

Uh oh!

matifali Aug 29, 2025

Uh oh!

blink-so bot Aug 29, 2025

Uh oh!

matifali Aug 29, 2025

Uh oh!

blink-so bot Aug 29, 2025

Uh oh!

github-actions bot commented Aug 29, 2025 •

edited

Loading

Uh oh!

david-fraley commented Aug 29, 2025

Uh oh!

Uh oh!

Uh oh!

	- [Deploy Coder offline](../../install/airgap.md)
	- [Deploy Coder Air-gapped](../../install/airgap.md)

	[offline deployments](../../install/airgap.md).
	[Air-gapped deployments](../../install/airgap.md).

docs: replace offline deployments terminology to air-gapped #19625

docs: replace offline deployments terminology to air-gapped #19625

Uh oh!

Conversation

blink-so bot commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes Made

Terminology Updates

Navigation & URL Structure

Internal Links & References

Backward Compatibility

Rationale

Testing

Result

Uh oh!

david-fraley commented Aug 28, 2025

Uh oh!

matifali left a comment

Choose a reason for hiding this comment

Uh oh!

matifali Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

blink-so bot Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

matifali Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

blink-so bot Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

david-fraley commented Aug 29, 2025

Uh oh!

Uh oh!

Uh oh!

blink-so bot commented Aug 28, 2025 •

edited

Loading

github-actions bot commented Aug 29, 2025 •

edited

Loading