refactor: improve notification template

evgeniy-scherbina · evgeniy-scherbina · commit b7a34c5d5257 · 2025-05-21T18:35:09.000Z
diff --git a/coderd/database/migrations/000328_prebuild_failure_limit_notification.up.sql b/coderd/database/migrations/000328_prebuild_failure_limit_notification.up.sql
@@ -7,6 +7,10 @@ VALUES ('414d9331-c1fc-4761-b40c-d1f4702279eb',
 The number of failed prebuild attempts has reached the hard limit for template **{{ .Labels.template }}** and preset **{{ .Labels.preset }}**.
 
 To resume prebuilds, fix the underlying issue and upload a new template version.
+
+Refer to the documentation for more details:
+- [Troubleshooting templates](https://coder.com/docs/admin/templates/troubleshooting)
+- [Troubleshooting of prebuilt workspaces](https://coder.com/docs/admin/templates/extending-templates/prebuilt-workspaces#administration-and-troubleshooting)
 $$,
 		'Template Events',
 		'[
diff --git a/coderd/notifications/testdata/rendered-templates/smtp/PrebuildFailureLimitReached.html.golden b/coderd/notifications/testdata/rendered-templates/smtp/PrebuildFailureLimitReached.html.golden
@@ -18,6 +18,14 @@ ate docker and preset particle-accelerator.
 To resume prebuilds, fix the underlying issue and upload a new template ver=
 sion.
 
+Refer to the documentation for more details:
+
+Troubleshooting templates (https://coder.com/docs/admin/templates/troublesh=
+ooting)
+Troubleshooting of prebuilt workspaces (https://coder.com/docs/admin/templa=
+tes/extending-templates/prebuilt-workspaces#administration-and-troubleshoot=
+ing)
+
 
 View failed prebuilt workspaces: http://test.com/workspaces?filter=3Downer:=
 prebuilds+status:failed+template:docker
@@ -60,6 +68,13 @@ tor</strong>.</p>
 
 <p>To resume prebuilds, fix the underlying issue and upload a new template =
 version.</p>
+
+<p>Refer to the documentation for more details:<br>
+- <a href=3D"https://coder.com/docs/admin/templates/troubleshooting">Troubl=
+eshooting templates</a><br>
+- <a href=3D"https://coder.com/docs/admin/templates/extending-templates/pre=
+built-workspaces#administration-and-troubleshooting">Troubleshooting of pre=
+built workspaces</a></p>
       </div>
       <div style=3D"text-align: center; margin-top: 32px;">
        =20
diff --git a/coderd/notifications/testdata/rendered-templates/webhook/PrebuildFailureLimitReached.json.golden b/coderd/notifications/testdata/rendered-templates/webhook/PrebuildFailureLimitReached.json.golden
@@ -30,6 +30,6 @@
   },
   "title": "There is a problem creating prebuilt workspaces",
   "title_markdown": "There is a problem creating prebuilt workspaces",
-  "body": "The number of failed prebuild attempts has reached the hard limit for template docker and preset particle-accelerator.\n\nTo resume prebuilds, fix the underlying issue and upload a new template version.",
-  "body_markdown": "\nThe number of failed prebuild attempts has reached the hard limit for template **docker** and preset **particle-accelerator**.\n\nTo resume prebuilds, fix the underlying issue and upload a new template version.\n"
+  "body": "The number of failed prebuild attempts has reached the hard limit for template docker and preset particle-accelerator.\n\nTo resume prebuilds, fix the underlying issue and upload a new template version.\n\nRefer to the documentation for more details:\n\nTroubleshooting templates (https://coder.com/docs/admin/templates/troubleshooting)\nTroubleshooting of prebuilt workspaces (https://coder.com/docs/admin/templates/extending-templates/prebuilt-workspaces#administration-and-troubleshooting)",
+  "body_markdown": "\nThe number of failed prebuild attempts has reached the hard limit for template **docker** and preset **particle-accelerator**.\n\nTo resume prebuilds, fix the underlying issue and upload a new template version.\n\nRefer to the documentation for more details:\n- [Troubleshooting templates](https://coder.com/docs/admin/templates/troubleshooting)\n- [Troubleshooting of prebuilt workspaces](https://coder.com/docs/admin/templates/extending-templates/prebuilt-workspaces#administration-and-troubleshooting)\n"
 }

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,6 @@`
`30`	`30`	`},`
`31`	`31`	`"title": "There is a problem creating prebuilt workspaces",`
`32`	`32`	`"title_markdown": "There is a problem creating prebuilt workspaces",`
`33`		`- "body": "The number of failed prebuild attempts has reached the hard limit for template docker and preset particle-accelerator.\n\nTo resume prebuilds, fix the underlying issue and upload a new template version.",`
`34`		`- "body_markdown": "\nThe number of failed prebuild attempts has reached the hard limit for template docker and preset particle-accelerator.\n\nTo resume prebuilds, fix the underlying issue and upload a new template version.\n"`
	`33`	+ "body": "The number of failed prebuild attempts has reached the hard limit for template docker and preset particle-accelerator.\n\nTo resume prebuilds, fix the underlying issue and upload a new template version.\n\nRefer to the documentation for more details:\n\nTroubleshooting templates (https://coder.com/docs/admin/templates/troubleshooting)\nTroubleshooting of prebuilt workspaces (https://coder.com/docs/admin/templates/extending-templates/prebuilt-workspaces#administration-and-troubleshooting)",
	`34`	+ "body_markdown": "\nThe number of failed prebuild attempts has reached the hard limit for template docker and preset particle-accelerator.\n\nTo resume prebuilds, fix the underlying issue and upload a new template version.\n\nRefer to the documentation for more details:\n- [Troubleshooting templates](https://coder.com/docs/admin/templates/troubleshooting)\n- [Troubleshooting of prebuilt workspaces](https://coder.com/docs/admin/templates/extending-templates/prebuilt-workspaces#administration-and-troubleshooting)\n"
`35`	`35`	`}`