From 98bb615f2fd6ed638639c25f8781d6632fc58bf0 Mon Sep 17 00:00:00 2001 From: BrunoQuaresma Date: Mon, 24 Apr 2023 13:53:22 +0000 Subject: [PATCH 1/4] docs(site): Mention template editor in template edit docs --- docs/templates/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/templates/README.md b/docs/templates/README.md index 10f0c6f800986..3400761d7c888 100644 --- a/docs/templates/README.md +++ b/docs/templates/README.md @@ -244,9 +244,13 @@ resource "kubernetes_pod" "podName" { ### Edit templates -You can edit a template using the coder CLI. Only [template admins and +You can edit a template using the coder CLI or the UI. Only [template admins and owners](../admin/users.md) can edit a template. +Using the UI, navigate to the template page, click on the "three dots" button, and select the option "Edit files". In the template editor, you create, edit and remove files. After every change, you have to build the template with the new modifications, to test if they are valid, and after you can publish them make the new template version the active one (the version that is used by default) or not. + +> **Tip**: By not publishing a version as active, you can try them in a workspace before making it default for everybody in your organization. This is helpful to debug new changes without impacting others. + Using the CLI, login to Coder and run the following command to edit a single template: From c5c13e1a2457d2b7f1103c0f2ce596435d1d5d09 Mon Sep 17 00:00:00 2001 From: Bruno Quaresma Date: Tue, 25 Apr 2023 19:40:39 -0300 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Kira Pilot --- docs/templates/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/templates/README.md b/docs/templates/README.md index 3400761d7c888..a654ecf4f19f0 100644 --- a/docs/templates/README.md +++ b/docs/templates/README.md @@ -247,9 +247,9 @@ resource "kubernetes_pod" "podName" { You can edit a template using the coder CLI or the UI. Only [template admins and owners](../admin/users.md) can edit a template. -Using the UI, navigate to the template page, click on the "three dots" button, and select the option "Edit files". In the template editor, you create, edit and remove files. After every change, you have to build the template with the new modifications, to test if they are valid, and after you can publish them make the new template version the active one (the version that is used by default) or not. +Using the UI, navigate to the template page, click on the Kebab menu, and select the option to "Edit files". In the template editor, you create, edit and remove files. Before publishing a new template version, you can test your modifications by clicking the "Build template" button. Newly published template versions automatically become the default version selection when creating a workspace. -> **Tip**: By not publishing a version as active, you can try them in a workspace before making it default for everybody in your organization. This is helpful to debug new changes without impacting others. +> **Tip**: Even without publishing a version as active, you can still use it to create a workspace before making it the default for everybody in your organization. This may help you debug new changes without impacting others. Using the CLI, login to Coder and run the following command to edit a single template: From bcecbfe527f3d37fba3f2aca32dc5ede2dcf5520 Mon Sep 17 00:00:00 2001 From: Ben Potter Date: Tue, 25 Apr 2023 20:58:35 -0500 Subject: [PATCH 3/4] Update docs/templates/README.md --- docs/templates/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/templates/README.md b/docs/templates/README.md index a654ecf4f19f0..8bf9298fcdd6f 100644 --- a/docs/templates/README.md +++ b/docs/templates/README.md @@ -247,7 +247,7 @@ resource "kubernetes_pod" "podName" { You can edit a template using the coder CLI or the UI. Only [template admins and owners](../admin/users.md) can edit a template. -Using the UI, navigate to the template page, click on the Kebab menu, and select the option to "Edit files". In the template editor, you create, edit and remove files. Before publishing a new template version, you can test your modifications by clicking the "Build template" button. Newly published template versions automatically become the default version selection when creating a workspace. +Using the UI, navigate to the template page, click on the menu, and select "Edit files". In the template editor, you create, edit and remove files. Before publishing a new template version, you can test your modifications by clicking the "Build template" button. Newly published template versions automatically become the default version selection when creating a workspace. > **Tip**: Even without publishing a version as active, you can still use it to create a workspace before making it the default for everybody in your organization. This may help you debug new changes without impacting others. From 6a853ea00fe5a27a7438abc93fc66a405d29001c Mon Sep 17 00:00:00 2001 From: BrunoQuaresma Date: Wed, 26 Apr 2023 11:59:50 +0000 Subject: [PATCH 4/4] Fix format --- docs/templates/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/templates/README.md b/docs/templates/README.md index 8bf9298fcdd6f..946119020dcea 100644 --- a/docs/templates/README.md +++ b/docs/templates/README.md @@ -247,7 +247,7 @@ resource "kubernetes_pod" "podName" { You can edit a template using the coder CLI or the UI. Only [template admins and owners](../admin/users.md) can edit a template. -Using the UI, navigate to the template page, click on the menu, and select "Edit files". In the template editor, you create, edit and remove files. Before publishing a new template version, you can test your modifications by clicking the "Build template" button. Newly published template versions automatically become the default version selection when creating a workspace. +Using the UI, navigate to the template page, click on the menu, and select "Edit files". In the template editor, you create, edit and remove files. Before publishing a new template version, you can test your modifications by clicking the "Build template" button. Newly published template versions automatically become the default version selection when creating a workspace. > **Tip**: Even without publishing a version as active, you can still use it to create a workspace before making it the default for everybody in your organization. This may help you debug new changes without impacting others.