Skip to content

Commit 02ecf32

Browse files
blink-so[bot]david-fraley
blink-so[bot]
and
david-fraley
authored
docs: replace offline deployments terminology to air-gapped (coder#19625)
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 - [x] Verified all internal links point to the new URL structure - [x] Confirmed navigation title updates correctly - [x] Ensured content accuracy is maintained - [x] Added redirects for backward compatibility (main page + subsections) - [x] Updated all cross-references in related documentation - [x] Verified subsection anchor redirects work properly - [x] 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 --------- Co-authored-by: blink-so[bot] <211532188+blink-so[bot]@users.noreply.github.com> Co-authored-by: david-fraley <67079030+david-fraley@users.noreply.github.com>
1 parent e5ac640 commit 02ecf32

File tree

9 files changed

+25
-21
lines changed

9 files changed

+25
-21
lines changed

‎docs/_redirects

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Redirect old offline deployments URL to new airgap URL
2+
/install/offline /install/airgap 301
3+
4+
# Redirect old offline anchor fragments to new airgap anchors
5+
/install/offline#offline-docs /install/airgap#airgap-docs 301
6+
/install/offline#offline-container-images /install/airgap#airgap-container-images 301

‎docs/admin/integrations/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ our [installation guides](../../install/index.md).
1313
The following resources may help as you're deploying Coder.
1414

1515
- [Coder packages: one-click install on cloud providers](https://github.com/coder/packages)
16-
- [Deploy Coder offline](../../install/offline.md)
16+
- [Deploy Coder Air-gapped](../../install/airgap.md)
1717
- [Supported resources (Terraform registry)](https://registry.terraform.io)
1818
- [Writing custom templates](../templates/index.md)

‎docs/admin/integrations/jfrog-artifactory.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,9 @@ To set this up, follow these steps:
129129
If you don't want to use the official modules, you can read through the [example template](https://github.com/coder/coder/tree/main/examples/jfrog/docker), which uses Docker as the underlying compute. The
130130
same concepts apply to all compute types.
131131

132-
## Offline Deployments
132+
## Air-Gapped Deployments
133133

134-
See the [offline deployments](../templates/extending-templates/modules.md#offline-installations) section for instructions on how to use Coder modules in an offline environment with Artifactory.
134+
See the [air-gapped deployments](../templates/extending-templates/modules.md#offline-installations) section for instructions on how to use Coder modules in an offline environment with Artifactory.
135135

136136
## Next Steps
137137

‎docs/admin/networking/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,12 @@ If a direct connection is not available (e.g. client or server is behind NAT),
116116
Coder will use a relayed connection. By default,
117117
[Coder uses Google's public STUN server](../../reference/cli/server.md#--derp-server-stun-addresses),
118118
but this can be disabled or changed for
119-
[offline deployments](../../install/offline.md).
119+
[Air-gapped deployments](../../install/airgap.md).
120120

121121
### Relayed connections
122122

123123
By default, your Coder server also runs a built-in DERP relay which can be used
124-
for both public and [offline deployments](../../install/offline.md).
124+
for both public and [Air-gapped deployments](../../install/airgap.md).
125125

126126
However, our Wireguard integration through Tailscale has graciously allowed us
127127
to use
@@ -135,7 +135,7 @@ coder server --derp-config-url https://controlplane.tailscale.com/derpmap/defaul
135135
#### Custom Relays
136136

137137
If you want lower latency than what Tailscale offers or want additional DERP
138-
relays for offline deployments, you may run custom DERP servers. Refer to
138+
relays for air-gapped deployments, you may run custom DERP servers. Refer to
139139
[Tailscale's documentation](https://tailscale.com/kb/1118/custom-derp-servers/#why-run-your-own-derp-server)
140140
to learn how to set them up.
141141

‎docs/changelogs/v0.27.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Agent logs can be pushed after a workspace has started (#8528)
2525
- Template version messages (#8435)
2626
<img width="428" alt="252772262-087f1338-f1e2-49fb-81f2-358070a46484" src="https://github.com/coder/coder/assets/22407953/5f6e5e47-e61b-41f1-92fe-f624e92f8bd3">
2727
- TTL and max TTL validation increased to 30 days (#8258)
28-
- [Self-hosted docs](https://coder.com/docs/install/offline#offline-docs):
28+
- [Self-hosted docs](https://coder.com/docs/install/airgap#airgap-docs):
2929
Host your own copy of Coder's documentation in your own environment (#8527)
3030
(#8601)
3131
- Add custom coder bin path for `config-ssh` (#8425)

‎docs/changelogs/v2.8.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383

8484
### Documentation
8585

86-
- Using coder modules in offline deployments (#11788) (@matifali)
86+
- Using coder modules in air-gapped deployments (#11788) (@matifali)
8787
- Simplify JFrog integration docs (#11787) (@matifali)
8888
- Add guide for azure federation (#11864) (@ericpaulsen)
8989
- Fix example template README 404s and semantics (#11903) (@ericpaulsen)

‎docs/install/offline.md renamed to ‎docs/install/airgap.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
# Offline Deployments
2-
3-
All Coder features are supported in offline / behind firewalls / in air-gapped
4-
environments. However, some changes to your configuration are necessary.
1+
# Air-gapped Deployments
52

3+
All Coder features are supported in air-gapped / behind firewalls / disconnected / offline.
64
This is a general comparison. Keep reading for a full tutorial running Coder
7-
offline with Kubernetes or Docker.
5+
air-gapped with Kubernetes or Docker.
86

9-
| | Public deployments | Offline deployments |
7+
| | Public deployments | Air-gapped deployments |
108
|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
119
| Terraform binary | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com) | Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](https://github.com/coder/coder/blob/main/provisioner/terraform/install.go#L23-L24) |
1210
| Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template | [Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below |
@@ -16,7 +14,7 @@ offline with Kubernetes or Docker.
1614
| Telemetry | Telemetry is on by default, and [can be disabled](../reference/cli/server.md#--telemetry) | Telemetry [can be disabled](../reference/cli/server.md#--telemetry) |
1715
| Update check | By default, Coder checks for updates from [GitHub releases](https://github.com/coder/coder/releases) | Update checks [can be disabled](../reference/cli/server.md#--update-check) |
1816

19-
## Offline container images
17+
## Air-gapped container images
2018

2119
The following instructions walk you through how to build a custom Coder server
2220
image for Docker or Kubernetes
@@ -214,9 +212,9 @@ coder:
214212

215213
</div>
216214

217-
## Offline docs
215+
## Air-gapped docs
218216

219-
Coder also provides offline documentation in case you want to host it on your
217+
Coder also provides air-gapped documentation in case you want to host it on your
220218
own server. The docs are exported as static files that you can host on any web
221219
server, as demonstrated in the example below:
222220

‎docs/manifest.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,9 @@
154154
]
155155
},
156156
{
157-
"title": "Offline Deployments",
158-
"description": "Run Coder in offline / air-gapped environments",
159-
"path": "./install/offline.md",
157+
"title": "Air-gapped Deployments",
158+
"description": "Run Coder in air-gapped / disconnected / offline environments",
159+
"path": "./install/airgap.md",
160160
"icon_path": "./images/icons/lan.svg"
161161
},
162162
{

‎docs/tutorials/faqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ References:
332332
## Can I run Coder in an air-gapped or offline mode? (no Internet)?
333333
334334
Yes, Coder can be deployed in
335-
[air-gapped or offline mode](../install/offline.md).
335+
[air-gapped or offline mode](../install/airgap.md).
336336
337337
Our product bundles with the Terraform binary so assume access to terraform.io
338338
during installation. The docs outline rebuilding the Coder container with

0 commit comments

Comments
 (0)