Merge branch 'main' into vscode-web

coder · matifali · Oct 18, 2023 · Jul 28, 2023 · Jul 28, 2023 · Jul 28, 2023
commit 43479bc23b6674c545af80a0533f698db0c13669
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -235,11 +235,6 @@
           "description": "Fix common template problems",
           "path": "./templates/troubleshooting.md"
         },
-        {
-          "title": "Terraform Modules",
-          "description": "Reuse code across Coder templates",
-          "path": "./templates/modules.md"
-        },
         {
           "title": "Process Logging",
           "description": "Audit commands in workspaces with exectrace",

diff --git a/docs/templates/agent-metadata.md b/docs/templates/agent-metadata.md
@@ -90,8 +90,6 @@ resource "coder_agent" "main" {
 
 You can also show agent metadata for information about the workspace's host.
 
-You can also show agent metadata for information about the workspace's host.
-
 [top](https://manpages.ubuntu.com/manpages/jammy/en/man1/top.1.html) is
 available in most Linux distributions and provides virtual memory, CPU and IO
 statistics. Running `top` produces output that looks like:
@@ -143,3 +141,8 @@ You can expect `(10 * 6 * 2) / 4`, or 30 writes per second.
 
 One of the writes is to the `UNLOGGED` `workspace_agent_metadata` table and the
 other to the `NOTIFY` query that enables live stats streaming in the UI.
+
+## Next Steps
+
+- [Resource metadata](./resource-metadata.md)
+- [Parameters](./parameters.md)
diff --git a/docs/templates/open-in-coder.md b/docs/templates/open-in-coder.md
@@ -15,9 +15,8 @@ approach for "Open in Coder" flows.
 
 ### 1. Set up git authentication
 
-See
-[Git Authentication](../admin/git-providers.md#require-git-authentication-in-templates)
-in your Coder deployment
+See [External Authentication](../admin/external-auth.md) to set up git
+authentication in your Coder deployment.
 
 ### 2. Modify your template to auto-clone repos
 
@@ -115,12 +114,6 @@ specified in your template in the `disable_params` search params list
 [![Open in Coder](https://YOUR_ACCESS_URL/open-in-coder.svg)](https://YOUR_ACCESS_URL/templates/YOUR_TEMPLATE/workspace?disable_params=first_parameter,second_parameter)
 ```
 
-specified in your template in the `disable_params` search params list
-
-```md
-[![Open in Coder](https://YOUR_ACCESS_URL/open-in-coder.svg)](https://YOUR_ACCESS_URL/templates/YOUR_TEMPLATE/workspace?disable_params=first_parameter,second_parameter)
-```
-
 ### Example: Kubernetes
 
 For a full example of the Open in Coder flow in Kubernetes, check out

diff --git a/docs/templates/parameters.md b/docs/templates/parameters.md
@@ -270,3 +270,14 @@ data "coder_parameter" "project_id" {
 As parameters are intended to be used only for workspace customization purposes,
 Terraform variables can be freely managed by the template author to build
 templates. Workspace users are not able to modify template variables.
+
+```hcl
+
+variable "CLOUD_API_KEY" {
+  type        = string
+  description = "API key for the service"
+  default     = "1234567890"
+  sensitive   = true
+}
+
+```
diff --git a/docs/templates/resource-metadata.md b/docs/templates/resource-metadata.md
@@ -105,7 +105,6 @@ icons:
 We also have other icons related to the IDEs. You can see more information on
 how to use the builtin icons [here](./icons.md).
 
-
 ## Up next
 
 - [Secrets](../secrets.md)

diff --git a/docs/templates/tour.md b/docs/templates/tour.md
@@ -406,8 +406,8 @@ The template-tour template has been created! Developers can provision a workspac
    coder create --template="template-tour" [workspace name]
 ```
 
-In your web browser, log in to your Coder dashboard, select **Templates**.
-Your template is ready to use for new workspaces.
+In your web browser, log in to your Coder dashboard, select **Templates**. Your
+template is ready to use for new workspaces.
 
 ![Your new template, ready to use](../images/templates/template-tour.png)
 

diff --git a/docs/templates/tutorial.md b/docs/templates/tutorial.md
@@ -61,7 +61,7 @@ After a few seconds, your workspace is ready to use.
 
 ![Workspace is ready](../images/templates/workspace-ready.png)
 
-## 6. Try out your new workspace
+## 5. Try out your new workspace
 
 This starter template lets you connect to your workspace in a few ways:
 
@@ -81,7 +81,7 @@ This starter template lets you connect to your workspace in a few ways:
 
 When you're done, you can stop the workspace.
 
-## 7. Modify your template
+## 6. Modify your template
 
 Now you can modify your template to suit your team's needs.