blink-so[bot] and david-fraley
02ecf32afe
docs: replace offline deployments terminology to air-gapped ( #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 >
2025-08-29 09:34:44 -05:00
Atif Ali
2b3ae549ca
chore: rename docker-compose.yaml to compose.yaml ( #19480 )
...
Docker recommends using a `compose.yaml` file.
2025-08-23 11:32:14 +05:00
0ef7d0b3e5
docs: correct low MTU troubleshooting language ( #17468 )
...
Fixes docs troubleshooting language around low MTU. In fact, we see
conenctions hanging rather than just showing low performance, since
packets are dropped rather than fragmented.
---------
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-23 10:00:33 +04:00
Edward Angert and EdwardAngert
43d584c4f3
docs: add a section about latency and how it's measured ( #16734 )
...
closes https://github.com/coder/coder/issues/14942
- what latency is measured
- where it's reported
- how users experience latency
- how to lower latency
[preview](https://coder.com/docs/@14942-latency/admin/networking#latency )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-04 08:12:11 -04:00
Edward Angert and EdwardAngert
0fe7346264
docs: remove enterprise from docs ( #17226 )
...
Enterprise is a legacy plan that has been replaced by Premium.
[preview](https://coder.com/docs/@enterprise-feats )
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-02 16:51:57 -04:00
101b62dc3e
docs: convert alerts to use GitHub Flavored Markdown (GFM) ( #16850 )
...
followup to #16761
thanks @lucasmelin !
+ thanks: @ethanndickson @Parkreiner @matifali @aqandrew
- [x] update snippet
- [x] find/replace
- [x] spot-check
[preview](https://coder.com/docs/@16761-gfm-callouts/admin/templates/managing-templates/schedule )
(and others)
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: M Atif Ali <atif@coder.com >
2025-03-10 16:58:20 -04:00
Guspan Tanadi
fc2815cfdb
docs: fix anchor and repo links ( #16555 )
2025-03-02 09:55:36 -06:00
Cian Johnston
b70437dbad
chore(docs/admin/networking/index.md): remove duplicate note ( #16322 )
2025-01-29 11:13:56 +00:00
Muhammad Atif Ali and Edward Angert
94f5d52fdc
chore: adopt markdownlint and markdown-table-formatter for *.md ( #15831 )
...
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2025-01-03 13:12:59 +00:00
Edward Angert
bcb15aab42
docs: add context for wireguard in places referencing tailscale ( #15901 )
...
> We do not use Tailscale (product) but instead import Tailscale OSS
libraries which has some nice ways of handling Wireguard. We also use
Tailscale's logo in our architecture, but calling it only `Tailscale`
seems to throw people off when they're considering Coder and how it
works.
I've left it wherever it seems to make sense (such as when we talk about
[DERP](https://coder.com/docs/admin/networking#relayed-connections )),
and sprinkled some `Wireguard` and `websocket/HTTPS` where I could
2024-12-17 15:13:12 -05:00
21cc6f77fe
docs: move premium and enterprise badges from heading to info in admonition ( #15774 )
...
closes https://github.com/coder/coder.com/issues/666
[preview](https://coder.com/docs/@666-unheading-premium/user-guides/workspace-scheduling#autostop-requirement )
---------
Co-authored-by: EdwardAngert <2408959-EdwardAngert@users.noreply.gitlab.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-17 18:20:01 +00:00
Ethan
fa69d1ca74
ci: reenable link checker & fix broken links ( #15489 )
...
Follow-up on #15484 .
2024-11-13 16:04:10 +11:00
Stephen Kirby
971388762c
chore(docs): change mentions of enterprise to premium ( #15258 )
...
Matches our latest licensing verbiage.
2024-10-28 15:56:51 -05:00
Edward Angert and EdwardAngert
d7baa49d6d
docs: add primary to wsproxy ls ( #15185 )
...
Add primary to `coder wsproxy ls` results in
<https://coder.com/docs/admin/networking/workspace-proxies#step-2-deploy-the-proxy >
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-10-23 11:15:55 -04:00
Edward Angert and EdwardAngert
20a9e9bdfb
chore(docs): remove workspace proxy map ( #15070 )
...
remove workspace proxy map
- replace later with another image or diagram
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-10-23 11:15:32 -04:00
419eba5fb6
docs: restructure docs ( #14421 )
...
Closes #13434
Supersedes #14182
---------
Co-authored-by: Ethan <39577870+ethanndickson@users.noreply.github.com >
Co-authored-by: Ethan Dickson <ethan@coder.com >
Co-authored-by: Ben Potter <ben@coder.com >
Co-authored-by: Stephen Kirby <58410745+stirby@users.noreply.github.com >
Co-authored-by: Stephen Kirby <me@skirby.dev >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2024-10-05 10:52:04 -05:00
