From ad589a125d5425e6b8b74cca2b384c4db43e009a Mon Sep 17 00:00:00 2001 From: Eric Date: Fri, 23 Jun 2023 21:17:56 +0000 Subject: [PATCH] docs: add max lifetime docs and refactor UI helper text --- docs/workspaces.md | 7 +++++++ site/src/i18n/en/createTemplatePage.json | 8 ++++---- site/src/i18n/en/templateSettingsPage.json | 8 ++++---- 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/workspaces.md b/docs/workspaces.md index 43b61f595b305..757f0b02d75bc 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -59,6 +59,13 @@ one hour. IDE, SSH, Port Forwarding, and coder_app activity trigger this bump. ![autostop UI](./images/autostop.png) +### Max lifetime + +Max lifetime is a template-level setting that determines the number of hours a +workspace can run before it is automatically shutdown, regardless of any +active connections. This setting ensures workspaces do not run in perpetuity +when connections are left open inadvertently. + ## Updating workspaces Use the following command to update a workspace to the latest template version. diff --git a/site/src/i18n/en/createTemplatePage.json b/site/src/i18n/en/createTemplatePage.json index a94cf1c8b7b9d..d87e285c9265e 100644 --- a/site/src/i18n/en/createTemplatePage.json +++ b/site/src/i18n/en/createTemplatePage.json @@ -32,11 +32,11 @@ }, "helperText": { "defaultTTLHelperText_zero": "Workspaces will run until stopped manually.", - "defaultTTLHelperText_one": "Workspaces will default to stopping after {{count}} hour.", - "defaultTTLHelperText_other": "Workspaces will default to stopping after {{count}} hours.", + "defaultTTLHelperText_one": "Workspaces will default to stopping after {{count}} hour. If Coder detects workspace connection activity, the autostop timer is bumped up one hour.", + "defaultTTLHelperText_other": "Workspaces will default to stopping after {{count}} hours. If Coder detects workspace connection activity, the autostop timer is bumped up one hour.", "maxTTLHelperText_zero": "Workspaces may run indefinitely.", - "maxTTLHelperText_one": "Workspaces must stop within 1 hour of starting.", - "maxTTLHelperText_other": "Workspaces must stop within {{count}} hours of starting.", + "maxTTLHelperText_one": "Workspaces must stop within 1 hour of starting, regardless of any active connections.", + "maxTTLHelperText_other": "Workspaces must stop within {{count}} hours of starting, regardless of any active connections.", "allowUsersToCancel": "If checked, users may be able to corrupt their workspace." }, "upload": { diff --git a/site/src/i18n/en/templateSettingsPage.json b/site/src/i18n/en/templateSettingsPage.json index 853a55c059fb5..a5f01fc08e9ea 100644 --- a/site/src/i18n/en/templateSettingsPage.json +++ b/site/src/i18n/en/templateSettingsPage.json @@ -12,13 +12,13 @@ "defaultTTLMaxError": "Please enter a limit that is less than or equal to 168 hours (7 days).", "defaultTTLMinError": "Default time until autostop must not be less than 0.", "defaultTTLHelperText_zero": "Workspaces will run until stopped manually.", - "defaultTTLHelperText_one": "Workspaces will default to stopping after {{count}} hour.", - "defaultTTLHelperText_other": "Workspaces will default to stopping after {{count}} hours.", + "defaultTTLHelperText_one": "Workspaces will default to stopping after {{count}} hour. If Coder detects workspace connection activity, the autostop timer is bumped up one hour.", + "defaultTTLHelperText_other": "Workspaces will default to stopping after {{count}} hours. If Coder detects workspace connection activity, the autostop timer is bumped up one hour.", "maxTTLMaxError": "Please enter a limit that is less than or equal to 168 hours (7 days).", "maxTTLMinError": "Maximum time until autostop must not be less than 0.", "maxTTLHelperText_zero": "Workspaces may run indefinitely.", - "maxTTLHelperText_one": "Workspaces must stop within 1 hour of starting.", - "maxTTLHelperText_other": "Workspaces must stop within {{count}} hours of starting.", + "maxTTLHelperText_one": "Workspaces must stop within 1 hour of starting, regardless of any active connections.", + "maxTTLHelperText_other": "Workspaces must stop within {{count}} hours of starting, regardless of any active connections.", "failureTTLHelperText_zero": "Coder will not automatically stop failed workspaces", "failureTTLHelperText_one": "Coder will attempt to stop failed workspaces after {{count}} day.", "failureTTLHelperText_other": "Coder will attempt to stop failed workspaces after {{count}} days.",