chore: improve dormant workspace notification wording (#17100)

defelmnq · web-flow · commit ddb06741c91f · 2025-03-26T15:54:03.000+01:00
Related to #17099
diff --git a/coderd/database/migrations/000311_improve_dormant_workspace_notification.down.sql b/coderd/database/migrations/000311_improve_dormant_workspace_notification.down.sql
@@ -0,0 +1,3 @@
+UPDATE notification_templates SET body_template = E'Your workspace **{{.Labels.name}}** has been marked as [**dormant**](https://coder.com/docs/templates/schedule#dormancy-threshold-enterprise) because of {{.Labels.reason}}.\n' ||
+		E'Dormant workspaces are [automatically deleted](https://coder.com/docs/templates/schedule#dormancy-auto-deletion-enterprise) after {{.Labels.timeTilDormant}} of inactivity.\n' ||
+		E'To prevent deletion, use your workspace with the link below.' WHERE id = '0ea69165-ec14-4314-91f1-69566ac3c5a0';
diff --git a/coderd/database/migrations/000311_improve_dormant_workspace_notification.up.sql b/coderd/database/migrations/000311_improve_dormant_workspace_notification.up.sql
@@ -0,0 +1,3 @@
+UPDATE notification_templates SET body_template = E'Your workspace **{{.Labels.name}}** has been marked as [**dormant**](https://coder.com/docs/templates/schedule#dormancy-threshold-enterprise) due to inactivity exceeding the dormancy threshold.\n\n' ||
+	E'This workspace will be automatically deleted in {{.Labels.timeTilDormant}} if it remains inactive.\n\n' ||
+	E'To prevent deletion, activate your workspace using the link below.' WHERE id = '0ea69165-ec14-4314-91f1-69566ac3c5a0';
diff --git a/coderd/notifications/testdata/rendered-templates/smtp/TemplateWorkspaceDormant.html.golden b/coderd/notifications/testdata/rendered-templates/smtp/TemplateWorkspaceDormant.html.golden
@@ -13,12 +13,13 @@ 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) because of breache=
-d the template's threshold for inactivity.
-Dormant workspaces are automatically deleted (https://coder.com/docs/templa=
-tes/schedule#dormancy-auto-deletion-enterprise) after 24 hours of inactivit=
-y.
-To prevent deletion, use your workspace with the link below.
+m/docs/templates/schedule#dormancy-threshold-enterprise) due to inactivity =
+exceeding the dormancy threshold.
+
+This workspace will be automatically deleted in 24 hours if it remains inac=
+tive.
+
+To prevent deletion, activate your workspace using the link below.
 
 
 View workspace: http://test.com/@bobby/bobby-workspace
@@ -54,12 +55,13 @@ argin: 8px 0 32px; 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> because of breached the template&r=
-squo;s threshold for inactivity.<br>
-Dormant workspaces are <a href=3D"https://coder.com/docs/templates/schedule=
-#dormancy-auto-deletion-enterprise">automatically deleted</a> after 24 hour=
-s of inactivity.<br>
-To prevent deletion, use your workspace with the link below.</p>
+enterprise"><strong>dormant</strong></a> due to inactivity exceeding the do=
+rmancy threshold.</p>
+
+<p>This workspace will be automatically deleted in 24 hours if it remains i=
+nactive.</p>
+
+<p>To prevent deletion, activate your workspace using the link below.</p>
       </div>
       <div style=3D"text-align: center; margin-top: 32px;">
        =20
diff --git a/coderd/notifications/testdata/rendered-templates/webhook/TemplateWorkspaceDormant.json.golden b/coderd/notifications/testdata/rendered-templates/webhook/TemplateWorkspaceDormant.json.golden
@@ -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) because of breached the template's threshold for inactivity.\nDormant workspaces are automatically deleted (https://coder.com/docs/templates/schedule#dormancy-auto-deletion-enterprise) after 24 hours of inactivity.\nTo prevent deletion, use your workspace with the link below.",
-  "body_markdown": "Your workspace **bobby-workspace** has been marked as [**dormant**](https://coder.com/docs/templates/schedule#dormancy-threshold-enterprise) because of breached the template's threshold for inactivity.\nDormant workspaces are [automatically deleted](https://coder.com/docs/templates/schedule#dormancy-auto-deletion-enterprise) after 24 hours of inactivity.\nTo prevent deletion, use your workspace with the link below."
+  "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."
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+UPDATE notification_templates SET body_template = E'Your workspace {{.Labels.name}} has been marked as [dormant](https://coder.com/docs/templates/schedule#dormancy-threshold-enterprise) because of {{.Labels.reason}}.\n' \|\|`
	`2`	`+ E'Dormant workspaces are [automatically deleted](https://coder.com/docs/templates/schedule#dormancy-auto-deletion-enterprise) after {{.Labels.timeTilDormant}} of inactivity.\n' \|\|`
	`3`	`+ E'To prevent deletion, use your workspace with the link below.' WHERE id = '0ea69165-ec14-4314-91f1-69566ac3c5a0';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+UPDATE notification_templates SET body_template = E'Your workspace {{.Labels.name}} has been marked as [dormant](https://coder.com/docs/templates/schedule#dormancy-threshold-enterprise) due to inactivity exceeding the dormancy threshold.\n\n' \|\|`
	`2`	`+ E'This workspace will be automatically deleted in {{.Labels.timeTilDormant}} if it remains inactive.\n\n' \|\|`
	`3`	`+ E'To prevent deletion, activate your workspace using the link below.' WHERE id = '0ea69165-ec14-4314-91f1-69566ac3c5a0';`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,6 @@`
`27`	`27`	`},`
`28`	`28`	`"title": "Workspace \"bobby-workspace\" marked as dormant",`
`29`	`29`	`"title_markdown": "Workspace \"bobby-workspace\" marked as dormant",`
`30`		`- "body": "Your workspace bobby-workspace has been marked as dormant (https://coder.com/docs/templates/schedule#dormancy-threshold-enterprise) because of breached the template's threshold for inactivity.\nDormant workspaces are automatically deleted (https://coder.com/docs/templates/schedule#dormancy-auto-deletion-enterprise) after 24 hours of inactivity.\nTo prevent deletion, use your workspace with the link below.",`
`31`		`- "body_markdown": "Your workspace bobby-workspace has been marked as [dormant](https://coder.com/docs/templates/schedule#dormancy-threshold-enterprise) because of breached the template's threshold for inactivity.\nDormant workspaces are [automatically deleted](https://coder.com/docs/templates/schedule#dormancy-auto-deletion-enterprise) after 24 hours of inactivity.\nTo prevent deletion, use your workspace with the link below."`
	`30`	`+ "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.",`
	`31`	`+ "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."`
`32`	`32`	`}`