mirror of
https://github.com/coder/coder.git
synced 2026-06-02 20:48:20 +00:00
docs: remove unused _redirects file and document redirect process (#21144)
The _redirects file format is used by Netlify and Cloudflare Pages, but coder.com runs on Vercel with Next.js. Redirects for coder.com/docs must be configured in the coder/coder.com repository redirects.json file. This file was never functional and caused confusion when renaming docs. Co-authored-by: blink-so[bot] <211532188+blink-so[bot]@users.noreply.github.com>
This commit is contained in:
@@ -300,6 +300,17 @@ Some content is auto-generated with comments:
|
||||
|
||||
Don't manually edit auto-generated sections.
|
||||
|
||||
## URL Redirects
|
||||
|
||||
When renaming or moving documentation pages, redirects must be added to prevent broken links.
|
||||
|
||||
**Important**: Redirects are NOT configured in this repository. The coder.com website runs on Vercel with Next.js and reads redirects from a separate repository:
|
||||
|
||||
- **Redirect configuration**: https://github.com/coder/coder.com/blob/master/redirects.json
|
||||
- **Do NOT create** a `docs/_redirects` file - this format (used by Netlify/Cloudflare Pages) is not processed by coder.com
|
||||
|
||||
When you rename or move a doc page, create a PR in coder/coder.com to add the redirect.
|
||||
|
||||
## Key Principles
|
||||
|
||||
1. **Research first** - Verify against actual code implementation
|
||||
@@ -307,3 +318,4 @@ Don't manually edit auto-generated sections.
|
||||
3. **Visual structure** - Organize around screenshots when available
|
||||
4. **Link everything** - Related docs, API endpoints, CLI references
|
||||
5. **Manifest inclusion** - Add to manifest.json for navigation
|
||||
6. **Add redirects** - When moving/renaming pages, add redirects in coder/coder.com repo
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
# Redirect old offline deployments URL to new airgap URL
|
||||
/install/offline /install/airgap 301
|
||||
|
||||
# Redirect old offline anchor fragments to new airgap anchors
|
||||
/install/offline#offline-docs /install/airgap#airgap-docs 301
|
||||
/install/offline#offline-container-images /install/airgap#airgap-container-images 301
|
||||
|
||||
# Redirect old devcontainers folder to envbuilder
|
||||
/admin/templates/managing-templates/devcontainers /admin/templates/managing-templates/envbuilder 301
|
||||
/admin/templates/managing-templates/devcontainers/index /admin/templates/managing-templates/envbuilder 301
|
||||
/admin/templates/managing-templates/devcontainers/add-devcontainer /admin/templates/managing-templates/envbuilder/add-envbuilder 301
|
||||
/admin/templates/managing-templates/devcontainers/devcontainer-security-caching /admin/templates/managing-templates/envbuilder/envbuilder-security-caching 301
|
||||
/admin/templates/managing-templates/devcontainers/devcontainer-releases-known-issues /admin/templates/managing-templates/envbuilder/envbuilder-releases-known-issues 301
|
||||
Reference in New Issue
Block a user