Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
david-fraley merged 11 commits intomainfromblink/update-offline-docs-terminology
Aug 29, 2025

Conversation

blink-so[bot]
Copy link
Contributor

@blink-soblink-sobot commentedAug 28, 2025•
edited
Loading

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: Updateddocs/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: Addeddocs/_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' terminologyand 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-fraleydavid-fraley changed the titledocs: Update offline deployments terminology to air-gappeddocs: update offline deployments terminology to air-gappedAug 28, 2025
@david-fraleydavid-fraley changed the titledocs: update offline deployments terminology to air-gappeddocs: replace offline deployments terminology to air-gappedAug 28, 2025
@david-fraleydavid-fraley requested review frombpmct andmatifali and removed request forbpmctAugust 28, 2025 18:19
@david-fraley
Copy link
Collaborator

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

blink-so[bot] and bpmct reacted with thumbs up emoji

- 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 fileThis 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.mdThis ensures complete consistency with the new 'air-gapped' terminologywhile maintaining backward compatibility through redirects.
@blink-soblink-sobot changed the titledocs: replace offline deployments terminology to air-gappeddocs: Update offline deployments terminology to air-gappedAug 28, 2025
- 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 anchorThis ensures complete URL consistency including subsection anchorswhile maintaining backward compatibility for deep links.
Removed /install/offline.md redirect as users don't typically accessraw 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.
Copy link
Member

@matifalimatifali left a comment

Choose a reason for hiding this comment

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

Noticed a few missed mentions.


-[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)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
-[Deploy Coderoffline](../../install/airgap.md)
-[Deploy CoderAir-gapped](../../install/airgap.md)

blink-so[bot] reacted with thumbs up emoji
Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

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

[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).
Copy link
Member

Choose a reason for hiding this comment

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

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

blink-so[bot] reacted with thumbs up emoji
Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

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

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 updatedThanks 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.
@david-fraleydavid-fraley changed the titledocs: Update offline deployments terminology to air-gappeddocs: replace offline deployments terminology to air-gappedAug 29, 2025
@david-fraleydavid-fraley marked this pull request as ready for reviewAugust 29, 2025 13:57
@github-actionsGitHub Actions
Copy link

github-actionsbot commentedAug 29, 2025•
edited
Loading

All contributors have signed the CLA ✍️ ✅
Posted by theCLA Assistant Lite bot.

@david-fraley
Copy link
Collaborator

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

cdrci2 added a commit to coder/cla that referenced this pull requestAug 29, 2025
@david-fraleydavid-fraley merged commit02ecf32 intomainAug 29, 2025
27 of 28 checks passed
@david-fraleydavid-fraley deleted the blink/update-offline-docs-terminology branchAugust 29, 2025 14:34
@github-actionsgithub-actionsbot locked and limited conversation to collaboratorsAug 29, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@matifalimatifalimatifali approved these changes

@bpmctbpmctbpmct approved these changes

Assignees

@david-fraleydavid-fraley

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@david-fraley@matifali@bpmct
[8]ページ先頭
©2009-2025 Movatter.jp