mirror of
https://github.com/coder/coder.git
synced 2026-09-22 05:05:20 +08:00
fix: update stale docs URLs across non-TS files (#25750)
Closes [DOCS-256](https://linear.app/coder/issue/DOCS-256). Sibling to [DOCS-253](https://linear.app/coder/issue/DOCS-253) (#25740). Updates docs URL references across the non-TypeScript surface of `coder/coder` to match the current docs site structure. Source-of-truth for redirects is `coder/coder.com/redirects.json` (parent ticket [DOCS-209](https://linear.app/coder/issue/DOCS-209)). ## What changed | Area | Files | URL mapping | |---|---|---| | Top-level README | `README.md` | `/docs/workspaces` -> `/docs/user-guides/workspace-management`, `/docs/templates` -> `/docs/admin/templates`, `/docs/ides` -> `/docs/user-guides/workspace-access` | | Docs source | `docs/admin/security/0001_user_apikeys_invalidation.md` | `/docs/admin/audit-logs` -> `/docs/admin/security/audit-logs` | | Docs source | `docs/install/cloud/azure-vm.md` | `/docs/coder-oss/latest/install` -> `/docs/install` | | Dogfood | `dogfood/coder/guide.md` | `/docs/ides` -> `/docs/user-guides/workspace-access` | | Helm | `helm/coder/values.yaml` | `/docs/admin/workspace-proxies` -> `/docs/admin/networking/workspace-proxies` | | Enterprise coderd | `enterprise/coderd/coderd.go` | `/docs/admin/encryption` -> `/docs/admin/security/database-encryption` (error message) | | Release tooling | `scripts/release/main_internal_test.go` | `/docs/admin/upgrade` -> `/docs/install/upgrade` (test fixture, matches `generate_release_notes.sh`) | | AI bridge | `aibridge/client.go` | repinned to current `main` SHA on renamed `docs/ai-coder/ai-gateway/monitoring.md`, line range `#L47-L57` | | Example templates | 12 `examples/templates/*/README.md`, `examples/parameters/*`, `examples/parameters-dynamic-options/README.md`, `examples/workspace-tags/README.md`, `examples/parameters/main.tf`, `examples/examples.gen.json` (regenerated) | `/docs/workspaces` -> `/docs/user-guides/workspace-management`, `/docs/templates/parameters` -> `/docs/admin/templates/extending-templates/parameters`, `/docs/templates/dev-containers` -> `/docs/admin/integrations/devcontainers`, `/docs/dotfiles` -> `/docs/user-guides/workspace-dotfiles`, `/docs/about/architecture#agents` -> `/docs/admin/infrastructure/architecture#agents` | | Live notification templates (DB) | New migration `000510_fix_dormancy_notification_docs_urls.up.sql` and `.down.sql` plus the four regenerated SMTP/webhook goldens under `coderd/notifications/testdata/rendered-templates/` | `/docs/templates/schedule#dormancy-threshold-enterprise` -> `/docs/admin/templates/managing-templates/schedule#dormancy-threshold`, `/docs/templates/schedule#dormancy-auto-deletion-enterprise` -> `/docs/admin/templates/managing-templates/schedule#dormancy-auto-deletion` | The migration uses `REPLACE(body_template, ...)` scoped by template id and `LIKE '%/docs/templates/schedule%'`, so it works regardless of which intermediate state (`000232`, `000262`, `000305`, or `000311`) is currently in the row. ## What did not change Historical SQL migrations `000232`, `000262`, `000305`, and `000311` are not modified because migrations are immutable history. The 18 remaining stale URL references in those files are superseded at runtime by migration `000510`. This decision matches the pattern used in the A1 sister PR (#25740). ## Verification - `go test ./coderd/database/migrations/... -count=1` (UP+DOWN) - `go test ./coderd/notifications/ -run TestNotificationTemplates_Golden -update -count=1` to regenerate the four `.golden` files - `go test ./scripts/release/ -run Test_removeMainlineBlurb -count=1` - `make pre-commit` (gen + fmt + lint + slim build) ran clean as part of the commit hook I also fixed a pre-existing emdash on line 35 of `examples/templates/azure-linux/README.md` that the lint flagged once the file entered my diff. The line was already in `main`, but `make gen` rewrites `examples/examples.gen.json` whenever a `README.md` changes, so the line came back as a `+` in the diff against `origin/main` and the `lint/emdash` step refused it. <details> <summary>Pre-mortem</summary> | Risk | Mitigation | |---|---| | Migration overwrites future template edits | Used `REPLACE` instead of full body overwrite. `WHERE id IN (...) AND body_template LIKE '%/docs/templates/schedule%'` further scopes the write | | Goldens drift from migrated body | Regenerated goldens via `-update` after the migration was in place, so the goldens reflect the post-migration state | | Down migration leaves stale URLs | Down migration reverses the REPLACE so a rollback restores the prior URLs | | Fragment loss when redirect strips fragment | Verified the destination `schedule.md` contains `## Dormancy threshold` and `## Dormancy auto-deletion` anchors | | Terraform parse breakage in `examples/parameters/main.tf` | Only comments changed; Terraform parser is unaffected | | Test fixtures in `scripts/release` diverging from `generate_release_notes.sh` | Updated to match the script, which already emits `/docs/install/upgrade` | </details> --- Generated by Coder Agent on behalf of @nickvigilante.
This commit is contained in:
Nick Vigilante
@@ -0,0 +1,20 @@
|
||||
-- Revert the URL replacements applied by 000510. We use the reverse
|
||||
-- REPLACE so any other downstream edits to body_template are preserved.
|
||||
|
||||
UPDATE notification_templates
|
||||
SET
|
||||
body_template = REPLACE(
|
||||
REPLACE(
|
||||
body_template,
|
||||
'/docs/admin/templates/managing-templates/schedule#dormancy-threshold',
|
||||
'/docs/templates/schedule#dormancy-threshold-enterprise'
|
||||
),
|
||||
'/docs/admin/templates/managing-templates/schedule#dormancy-auto-deletion',
|
||||
'/docs/templates/schedule#dormancy-auto-deletion-enterprise'
|
||||
)
|
||||
WHERE
|
||||
id IN (
|
||||
'0ea69165-ec14-4314-91f1-69566ac3c5a0',
|
||||
'51ce2fdf-c9ca-4be1-8d70-628674f9bc42'
|
||||
)
|
||||
AND body_template LIKE '%/docs/admin/templates/managing-templates/schedule%';
|
||||
@@ -0,0 +1,28 @@
|
||||
-- Update stale docs URLs in the dormancy notification templates so that
|
||||
-- they point at the current documentation path and anchors:
|
||||
-- /docs/templates/schedule#dormancy-threshold-enterprise
|
||||
-- -> /docs/admin/templates/managing-templates/schedule#dormancy-threshold
|
||||
-- /docs/templates/schedule#dormancy-auto-deletion-enterprise
|
||||
-- -> /docs/admin/templates/managing-templates/schedule#dormancy-auto-deletion
|
||||
--
|
||||
-- We use REPLACE on body_template, scoped by id and LIKE so the update
|
||||
-- is robust to the various intermediate forms that prior migrations
|
||||
-- (000232, 000262, 000305, 000311) have left on disk.
|
||||
|
||||
UPDATE notification_templates
|
||||
SET
|
||||
body_template = REPLACE(
|
||||
REPLACE(
|
||||
body_template,
|
||||
'/docs/templates/schedule#dormancy-threshold-enterprise',
|
||||
'/docs/admin/templates/managing-templates/schedule#dormancy-threshold'
|
||||
),
|
||||
'/docs/templates/schedule#dormancy-auto-deletion-enterprise',
|
||||
'/docs/admin/templates/managing-templates/schedule#dormancy-auto-deletion'
|
||||
)
|
||||
WHERE
|
||||
id IN (
|
||||
'0ea69165-ec14-4314-91f1-69566ac3c5a0',
|
||||
'51ce2fdf-c9ca-4be1-8d70-628674f9bc42'
|
||||
)
|
||||
AND body_template LIKE '%/docs/templates/schedule%';
|
||||
+5
-5
@@ -13,8 +13,8 @@ Content-Type: text/plain; charset=UTF-8
|
||||
Hi Bobby,
|
||||
|
||||
Your workspace bobby-workspace has been marked as dormant (https://coder.co=
|
||||
m/docs/templates/schedule#dormancy-threshold-enterprise) due to inactivity =
|
||||
exceeding the dormancy threshold.
|
||||
m/docs/admin/templates/managing-templates/schedule#dormancy-threshold) due =
|
||||
to inactivity exceeding the dormancy threshold.
|
||||
|
||||
This workspace will be automatically deleted in 24 hours if it remains inac=
|
||||
tive.
|
||||
@@ -54,9 +54,9 @@ argin: 8px 0 32px; line-height: 1.5;">
|
||||
<div style=3D"line-height: 1.5;">
|
||||
<p>Hi Bobby,</p>
|
||||
<p>Your workspace <strong>bobby-workspace</strong> has been marked =
|
||||
as <a href=3D"https://coder.com/docs/templates/schedule#dormancy-threshold-=
|
||||
enterprise"><strong>dormant</strong></a> due to inactivity exceeding the do=
|
||||
rmancy threshold.</p>
|
||||
as <a href=3D"https://coder.com/docs/admin/templates/managing-templates/sch=
|
||||
edule#dormancy-threshold"><strong>dormant</strong></a> due to inactivity ex=
|
||||
ceeding the dormancy threshold.</p>
|
||||
|
||||
<p>This workspace will be automatically deleted in 24 hours if it remains i=
|
||||
nactive.</p>
|
||||
|
||||
coderd/notifications/testdata/rendered-templates/smtp/TemplateWorkspaceMarkedForDeletion.html.golden
Vendored
+5
-4
@@ -13,8 +13,9 @@ Content-Type: text/plain; charset=UTF-8
|
||||
Hi Bobby,
|
||||
|
||||
Your workspace bobby-workspace has been marked for deletion after 24 hours =
|
||||
of dormancy (https://coder.com/docs/templates/schedule#dormancy-auto-deleti=
|
||||
on-enterprise) because of template updated to new dormancy policy.
|
||||
of dormancy (https://coder.com/docs/admin/templates/managing-templates/sche=
|
||||
dule#dormancy-auto-deletion) because of template updated to new dormancy po=
|
||||
licy.
|
||||
To prevent deletion, use your workspace with the link below.
|
||||
|
||||
|
||||
@@ -51,8 +52,8 @@ argin: 8px 0 32px; line-height: 1.5;">
|
||||
<p>Hi Bobby,</p>
|
||||
<p>Your workspace <strong>bobby-workspace</strong> has been marked =
|
||||
for <strong>deletion</strong> after 24 hours of <a href=3D"https://coder.co=
|
||||
m/docs/templates/schedule#dormancy-auto-deletion-enterprise">dormancy</a> b=
|
||||
ecause of template updated to new dormancy policy.<br>
|
||||
m/docs/admin/templates/managing-templates/schedule#dormancy-auto-deletion">=
|
||||
dormancy</a> because of template updated to new dormancy policy.<br>
|
||||
To prevent deletion, use your workspace with the link below.</p>
|
||||
</div>
|
||||
<div style=3D"text-align: center; margin-top: 32px;">
|
||||
|
||||
Vendored
+2
-2
@@ -27,6 +27,6 @@
|
||||
},
|
||||
"title": "Workspace \"bobby-workspace\" marked as dormant",
|
||||
"title_markdown": "Workspace \"bobby-workspace\" marked as dormant",
|
||||
"body": "Your workspace bobby-workspace has been marked as dormant (https://coder.com/docs/templates/schedule#dormancy-threshold-enterprise) due to inactivity exceeding the dormancy threshold.\n\nThis workspace will be automatically deleted in 24 hours if it remains inactive.\n\nTo prevent deletion, activate your workspace using the link below.",
|
||||
"body_markdown": "Your workspace **bobby-workspace** has been marked as [**dormant**](https://coder.com/docs/templates/schedule#dormancy-threshold-enterprise) due to inactivity exceeding the dormancy threshold.\n\nThis workspace will be automatically deleted in 24 hours if it remains inactive.\n\nTo prevent deletion, activate your workspace using the link below."
|
||||
"body": "Your workspace bobby-workspace has been marked as dormant (https://coder.com/docs/admin/templates/managing-templates/schedule#dormancy-threshold) due to inactivity exceeding the dormancy threshold.\n\nThis workspace will be automatically deleted in 24 hours if it remains inactive.\n\nTo prevent deletion, activate your workspace using the link below.",
|
||||
"body_markdown": "Your workspace **bobby-workspace** has been marked as [**dormant**](https://coder.com/docs/admin/templates/managing-templates/schedule#dormancy-threshold) due to inactivity exceeding the dormancy threshold.\n\nThis workspace will be automatically deleted in 24 hours if it remains inactive.\n\nTo prevent deletion, activate your workspace using the link below."
|
||||
}
|
||||
+2
-2
@@ -26,6 +26,6 @@
|
||||
},
|
||||
"title": "Workspace \"bobby-workspace\" marked for deletion",
|
||||
"title_markdown": "Workspace \"bobby-workspace\" marked for deletion",
|
||||
"body": "Your workspace bobby-workspace has been marked for deletion after 24 hours of dormancy (https://coder.com/docs/templates/schedule#dormancy-auto-deletion-enterprise) because of template updated to new dormancy policy.\nTo prevent deletion, use your workspace with the link below.",
|
||||
"body_markdown": "Your workspace **bobby-workspace** has been marked for **deletion** after 24 hours of [dormancy](https://coder.com/docs/templates/schedule#dormancy-auto-deletion-enterprise) because of template updated to new dormancy policy.\nTo prevent deletion, use your workspace with the link below."
|
||||
"body": "Your workspace bobby-workspace has been marked for deletion after 24 hours of dormancy (https://coder.com/docs/admin/templates/managing-templates/schedule#dormancy-auto-deletion) because of template updated to new dormancy policy.\nTo prevent deletion, use your workspace with the link below.",
|
||||
"body_markdown": "Your workspace **bobby-workspace** has been marked for **deletion** after 24 hours of [dormancy](https://coder.com/docs/admin/templates/managing-templates/schedule#dormancy-auto-deletion) because of template updated to new dormancy policy.\nTo prevent deletion, use your workspace with the link below."
|
||||
}
|
||||
Reference in New Issue
Block a user