diff --git a/cli/templatecreate.go b/cli/templatecreate.go index c636522e51..f294e7d06f 100644 --- a/cli/templatecreate.go +++ b/cli/templatecreate.go @@ -237,7 +237,7 @@ func (r *RootCmd) templateCreate() *serpent.Command { }, { Flag: "require-active-version", - Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.", + Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise for more details.", Value: serpent.BoolOf(&requireActiveVersion), Default: "false", }, diff --git a/cli/templateedit.go b/cli/templateedit.go index aba146d195..8d0ecf3e20 100644 --- a/cli/templateedit.go +++ b/cli/templateedit.go @@ -290,7 +290,7 @@ func (r *RootCmd) templateEdit() *serpent.Command { }, { Flag: "require-active-version", - Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.", + Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise for more details.", Value: serpent.BoolOf(&requireActiveVersion), Default: "false", }, diff --git a/cli/testdata/coder_templates_create_--help.golden b/cli/testdata/coder_templates_create_--help.golden index 5bb7bb96b6..5cbd079355 100644 --- a/cli/testdata/coder_templates_create_--help.golden +++ b/cli/testdata/coder_templates_create_--help.golden @@ -54,7 +54,9 @@ OPTIONS: --require-active-version bool (default: false) Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only - feature. + feature. See + https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise + for more details. --var string-array Alias of --variable. diff --git a/cli/testdata/coder_templates_edit_--help.golden b/cli/testdata/coder_templates_edit_--help.golden index 12fdf0fec3..eab60ac359 100644 --- a/cli/testdata/coder_templates_edit_--help.golden +++ b/cli/testdata/coder_templates_edit_--help.golden @@ -86,7 +86,9 @@ OPTIONS: --require-active-version bool (default: false) Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only - feature. + feature. See + https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise + for more details. -y, --yes bool Bypass prompts. diff --git a/docs/images/templates/publish.png b/docs/images/templates/publish.png index bd72230a42..49ef74c134 100644 Binary files a/docs/images/templates/publish.png and b/docs/images/templates/publish.png differ diff --git a/docs/reference/cli/templates_create.md b/docs/reference/cli/templates_create.md index c2ab11bd49..9346948072 100644 --- a/docs/reference/cli/templates_create.md +++ b/docs/reference/cli/templates_create.md @@ -95,7 +95,7 @@ Specify a duration workspaces may be in the dormant state prior to being deleted | Type | bool | | Default | false | -Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. +Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise for more details. ### -y, --yes diff --git a/docs/reference/cli/templates_edit.md b/docs/reference/cli/templates_edit.md index ea60830951..b9a613bdd8 100644 --- a/docs/reference/cli/templates_edit.md +++ b/docs/reference/cli/templates_edit.md @@ -153,7 +153,7 @@ Allow users to customize the autostop TTL for workspaces on this template. This | Type | bool | | Default | false | -Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. +Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise for more details. ### --private diff --git a/docs/templates/tutorial.md b/docs/templates/tutorial.md index 7063b7b288..d75f556162 100644 --- a/docs/templates/tutorial.md +++ b/docs/templates/tutorial.md @@ -111,7 +111,7 @@ workspaces. ![Building a template](../images/templates/build-template.png) Select **Publish version**. In the **Publish new version** dialog, make sure -**Promote to default version** is checked then select **Publish**. +**Promote to active version** is checked then select **Publish**. ![Publish a template](../images/templates/publish.png) diff --git a/docs/workspaces.md b/docs/workspaces.md index 4b0cea71c8..2968420022 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -150,7 +150,7 @@ manually updated the workspace. ## Updating workspaces -After updating the default version of the template that a workspace was created +After updating the active version of the template that a workspace was created from, you can update the workspace. Coder will start the workspace with said version. diff --git a/site/src/pages/TemplateVersionEditorPage/PublishTemplateVersionDialog.tsx b/site/src/pages/TemplateVersionEditorPage/PublishTemplateVersionDialog.tsx index 0773c6ecd9..283613b5f8 100644 --- a/site/src/pages/TemplateVersionEditorPage/PublishTemplateVersionDialog.tsx +++ b/site/src/pages/TemplateVersionEditorPage/PublishTemplateVersionDialog.tsx @@ -10,11 +10,25 @@ import type { PublishVersionData } from "pages/TemplateVersionEditorPage/types"; import type { FC } from "react"; import { getFormHelpers } from "utils/formUtils"; import * as Yup from "yup"; +import { + HelpTooltip, + HelpTooltipContent, + HelpTooltipLink, + HelpTooltipLinksGroup, + HelpTooltipText, + HelpTooltipTitle, + HelpTooltipTrigger, +} from "../../components/HelpTooltip/HelpTooltip"; +import { docs } from "../../utils/docs"; export const Language = { versionNameLabel: "Version name", messagePlaceholder: "Write a short message about the changes you made...", - defaultCheckboxLabel: "Promote to default version", + defaultCheckboxLabel: "Promote to active version", + activeVersionHelpTitle: "Active versions", + activeVersionHelpText: + "Templates can enforce that the active version be used for all workspaces (enterprise-only)", + activeVersionHelpBody: "Review the documentation", }; export type PublishTemplateVersionDialogProps = DialogProps & { @@ -88,22 +102,46 @@ export const PublishTemplateVersionDialog: FC< rows={5} /> - { - await form.setFieldValue( - "isActiveVersion", - e.target.checked, - ); - }} - name="isActiveVersion" - /> - } - /> + + { + await form.setFieldValue( + "isActiveVersion", + e.target.checked, + ); + }} + name="isActiveVersion" + /> + } + /> + + + + + + + {Language.activeVersionHelpTitle} + + + {Language.activeVersionHelpText} + + + + {Language.activeVersionHelpBody} + + + + +