docs: expand on TTL flags (#9286)

* docs: expand on TTL flags

* make: gen

* Discard changes to site/src/api/api.ts

* Discard changes to site/src/xServices/templateVersion/templateVersionXService.ts

---------

Co-authored-by: Muhammad Atif Ali <matifali@live.com>
Co-authored-by: Muhammad Atif Ali <atif@coder.com>

cli/templatecreate.go

@@ -185,19 +185,19 @@ func (r *RootCmd) templateCreate() *clibase.Cmd {
 		},
 		{
 			Flag:        "default-ttl",
-			Description: "Specify a default TTL for workspaces created from this template.",
+			Description: "Specify a default TTL for workspaces created from this template. It is the default time before shutdown - workspaces created from this template default to this value. Maps to \"Default autostop\" in the UI.",
 			Default:     "24h",
 			Value:       clibase.DurationOf(&defaultTTL),
 		},
 		{
 			Flag:        "failure-ttl",
-			Description: "Specify a failure TTL for workspaces created from this template. This licensed feature's default is 0h (off).",
+			Description: "Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed \"start\" build before coder automatically schedules a \"stop\" build to cleanup.This licensed feature's default is 0h (off). Maps to \"Failure cleanup\"in the UI.",
 			Default:     "0h",
 			Value:       clibase.DurationOf(&failureTTL),
 		},
 		{
 			Flag:        "inactivity-ttl",
-			Description: "Specify an inactivity TTL for workspaces created from this template. This licensed feature's default is 0h (off).",
+			Description: "Specify an inactivity TTL for workspaces created from this template. It is the amount of time the workspace is not used before it is be stopped and auto-locked. This includes across multiple builds (e.g. auto-starts and stops). This licensed feature's default is 0h (off). Maps to \"Dormancy threshold\" in the UI.",
 			Default:     "0h",
 			Value:       clibase.DurationOf(&inactivityTTL),
 		},

cli/templateedit.go

@@ -142,12 +142,12 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
 		},
 		{
 			Flag:        "default-ttl",
-			Description: "Edit the template default time before shutdown - workspaces created from this template default to this value.",
+			Description: "Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to \"Default autostop\" in the UI.",
 			Value:       clibase.DurationOf(&defaultTTL),
 		},
 		{
 			Flag:        "max-ttl",
-			Description: "Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting. This is an enterprise-only feature.",
+			Description: "Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting, regardless of user activity. This is an enterprise-only feature. Maps to \"Max lifetime\" in the UI.",
 			Value:       clibase.DurationOf(&maxTTL),
 		},
 		{
@@ -176,13 +176,13 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
 		},
 		{
 			Flag:        "failure-ttl",
-			Description: "Specify a failure TTL for workspaces created from this template. This licensed feature's default is 0h (off).",
+			Description: "Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed \"start\" build before coder automatically schedules a \"stop\" build to cleanup.This licensed feature's default is 0h (off). Maps to \"Failure cleanup\" in the UI.",
 			Default:     "0h",
 			Value:       clibase.DurationOf(&failureTTL),
 		},
 		{
 			Flag:        "inactivity-ttl",
-			Description: "Specify an inactivity TTL for workspaces created from this template. This licensed feature's default is 0h (off).",
+			Description: "Specify an inactivity TTL for workspaces created from this template. It is the amount of time the workspace is not used before it is be stopped and auto-locked. This includes across multiple builds (e.g. auto-starts and stops). This licensed feature's default is 0h (off). Maps to \"Dormancy threshold\" in the UI.",
 			Default:     "0h",
 			Value:       clibase.DurationOf(&inactivityTTL),
 		},

cli/testdata/coder_templates_create_--help.golden

@@ -4,14 +4,18 @@ Create a template from the current directory or as specified by flag
 
 Options
       --default-ttl duration (default: 24h)
-          Specify a default TTL for workspaces created from this template.
+          Specify a default TTL for workspaces created from this template. It is
+          the default time before shutdown - workspaces created from this
+          template default to this value. Maps to "Default autostop" in the UI.
 
   -d, --directory string (default: .)
           Specify the directory to create from, use '-' to read tar from stdin.
 
       --failure-ttl duration (default: 0h)
-          Specify a failure TTL for workspaces created from this template. This
-          licensed feature's default is 0h (off).
+          Specify a failure TTL for workspaces created from this template. It is
+          the amount of time after a failed "start" build before coder
+          automatically schedules a "stop" build to cleanup.This licensed
+          feature's default is 0h (off). Maps to "Failure cleanup"in the UI.
 
       --ignore-lockfile bool (default: false)
           Ignore warnings about not having a .terraform.lock.hcl file present in
@@ -19,7 +23,10 @@ Create a template from the current directory or as specified by flag
 
       --inactivity-ttl duration (default: 0h)
           Specify an inactivity TTL for workspaces created from this template.
-          This licensed feature's default is 0h (off).
+          It is the amount of time the workspace is not used before it is be
+          stopped and auto-locked. This includes across multiple builds (e.g.
+          auto-starts and stops). This licensed feature's default is 0h (off).
+          Maps to "Dormancy threshold" in the UI.
 
       --max-ttl duration
           Edit the template maximum time before shutdown - workspaces created

cli/testdata/coder_templates_edit_--help.golden

@@ -16,7 +16,8 @@ Edit the metadata of a template by name.
 
       --default-ttl duration
           Edit the template default time before shutdown - workspaces created
-          from this template default to this value.
+          from this template default to this value. Maps to "Default autostop"
+          in the UI.
 
       --description string
           Edit the template description.
@@ -25,20 +26,26 @@ Edit the metadata of a template by name.
           Edit the template display name.
 
       --failure-ttl duration (default: 0h)
-          Specify a failure TTL for workspaces created from this template. This
-          licensed feature's default is 0h (off).
+          Specify a failure TTL for workspaces created from this template. It is
+          the amount of time after a failed "start" build before coder
+          automatically schedules a "stop" build to cleanup.This licensed
+          feature's default is 0h (off). Maps to "Failure cleanup" in the UI.
 
       --icon string
           Edit the template icon path.
 
       --inactivity-ttl duration (default: 0h)
           Specify an inactivity TTL for workspaces created from this template.
-          This licensed feature's default is 0h (off).
+          It is the amount of time the workspace is not used before it is be
+          stopped and auto-locked. This includes across multiple builds (e.g.
+          auto-starts and stops). This licensed feature's default is 0h (off).
+          Maps to "Dormancy threshold" in the UI.
 
       --max-ttl duration
           Edit the template maximum time before shutdown - workspaces created
           from this template must shutdown within the given duration after
-          starting. This is an enterprise-only feature.
+          starting, regardless of user activity. This is an enterprise-only
+          feature. Maps to "Max lifetime" in the UI.
 
       --name string
           Edit the template name.

docs/cli/templates_create.md

@@ -19,7 +19,7 @@ coder templates create [flags] [name]
 | Type    | <code>duration</code> |
 | Default | <code>24h</code>      |
 
-Specify a default TTL for workspaces created from this template.
+Specify a default TTL for workspaces created from this template. It is the default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
 
 ### -d, --directory
 
@@ -37,7 +37,7 @@ Specify the directory to create from, use '-' to read tar from stdin.
 | Type    | <code>duration</code> |
 | Default | <code>0h</code>       |
 
-Specify a failure TTL for workspaces created from this template. This licensed feature's default is 0h (off).
+Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup"in the UI.
 
 ### --ignore-lockfile
 
@@ -55,7 +55,7 @@ Ignore warnings about not having a .terraform.lock.hcl file present in the templ
 | Type    | <code>duration</code> |
 | Default | <code>0h</code>       |
 
-Specify an inactivity TTL for workspaces created from this template. This licensed feature's default is 0h (off).
+Specify an inactivity TTL for workspaces created from this template. It is the amount of time the workspace is not used before it is be stopped and auto-locked. This includes across multiple builds (e.g. auto-starts and stops). This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
 
 ### --max-ttl
 

docs/cli/templates_edit.md

@@ -45,7 +45,7 @@ Allow users to cancel in-progress workspace jobs.
 | ---- | --------------------- |
 | Type | <code>duration</code> |
 
-Edit the template default time before shutdown - workspaces created from this template default to this value.
+Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
 
 ### --description
 
@@ -70,7 +70,7 @@ Edit the template display name.
 | Type    | <code>duration</code> |
 | Default | <code>0h</code>       |
 
-Specify a failure TTL for workspaces created from this template. This licensed feature's default is 0h (off).
+Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup" in the UI.
 
 ### --icon
 
@@ -87,7 +87,7 @@ Edit the template icon path.
 | Type    | <code>duration</code> |
 | Default | <code>0h</code>       |
 
-Specify an inactivity TTL for workspaces created from this template. This licensed feature's default is 0h (off).
+Specify an inactivity TTL for workspaces created from this template. It is the amount of time the workspace is not used before it is be stopped and auto-locked. This includes across multiple builds (e.g. auto-starts and stops). This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
 
 ### --max-ttl
 
@@ -95,7 +95,7 @@ Specify an inactivity TTL for workspaces created from this template. This licens
 | ---- | --------------------- |
 | Type | <code>duration</code> |
 
-Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting. This is an enterprise-only feature.
+Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting, regardless of user activity. This is an enterprise-only feature. Maps to "Max lifetime" in the UI.
 
 ### --name