docs: make template git auth example in sync with git auth setup example (#7784)

sharkymark · web-flow · commit 49ae49095c92 · 2023-06-01T19:34:52.000Z
diff --git a/docs/templates/open-in-coder.md b/docs/templates/open-in-coder.md
@@ -15,68 +15,70 @@ To support any infrastructure and software stack, Coder provides a generic appro
 
 1. Modify your template to auto-clone repos:
 
-   - If you want the template to clone a specific git repo
-
-     ```hcl
-     # Require git authentication to use this template
-     data "coder_git_auth" "github" {
-         id = "github"
-     }
-
-     resource "coder_agent" "dev" {
-         # ...
-         dir = "~/coder"
-         startup_script =<<EOF
-
-         # Clone repo from GitHub
-         if [ ! -d "coder" ]
-         then
-             git clone https://github.com/coder/coder
-         fi
-
-         EOF
-     }
-     ```
-
-     > Note: The `dir` attribute can be set in multiple ways, for example:
-     >
-     > - `~/coder`
-     > - `/home/coder/coder`
-     > - `coder` (relative to the home directory)
-
-   - If you want the template to support any repository via [parameters](./parameters.md)
-
-     ```hcl
-     # Require git authentication to use this template
-     data "coder_git_auth" "github" {
-         id = "github"
-     }
-
-     # Prompt the user for the git repo URL
-     data "coder_parameter" "git_repo" {
-         name          = "git_repo"
-         display_name  = "Git repository"
-         default       = "https://github.com/coder/coder"
-     }
-
-     locals {
-         folder_name = try(element(split("/", data.coder_parameter.git_repo.value), length(split("/", data.coder_parameter.git_repo.value)) - 1), "")
-     }
-
-     resource "coder_agent" "dev" {
-         # ...
-         dir = "~/${local.folder_name}"
-         startup_script =<<EOF
-
-         # Clone repo from GitHub
-         if [ ! -d "${local.folder_name}" ]
-         then
-             git clone ${data.coder_parameter.git_repo.value}
-         fi
-
-         EOF
-     }
-     ```
+> The id in the template's `coder_git_auth` data source must match the `CODER_GITAUTH_0_ID` in the Coder deployment configuration.
+
+- If you want the template to clone a specific git repo
+
+  ```hcl
+  # Require git authentication to use this template
+  data "coder_git_auth" "github" {
+      id = "primary-github"
+  }
+
+  resource "coder_agent" "dev" {
+      # ...
+      dir = "~/coder"
+      startup_script =<<EOF
+
+      # Clone repo from GitHub
+      if [ ! -d "coder" ]
+      then
+          git clone https://github.com/coder/coder
+      fi
+
+      EOF
+  }
+  ```
+
+  > Note: The `dir` attribute can be set in multiple ways, for example:
+  >
+  > - `~/coder`
+  > - `/home/coder/coder`
+  > - `coder` (relative to the home directory)
+
+- If you want the template to support any repository via [parameters](./parameters.md)
+
+  ```hcl
+  # Require git authentication to use this template
+  data "coder_git_auth" "github" {
+      id = "primary-github"
+  }
+
+  # Prompt the user for the git repo URL
+  data "coder_parameter" "git_repo" {
+      name          = "git_repo"
+      display_name  = "Git repository"
+      default       = "https://github.com/coder/coder"
+  }
+
+  locals {
+      folder_name = try(element(split("/", data.coder_parameter.git_repo.value), length(split("/", data.coder_parameter.git_repo.value)) - 1), "")
+  }
+
+  resource "coder_agent" "dev" {
+      # ...
+      dir = "~/${local.folder_name}"
+      startup_script =<<EOF
+
+      # Clone repo from GitHub
+      if [ ! -d "${local.folder_name}" ]
+      then
+          git clone ${data.coder_parameter.git_repo.value}
+      fi
+
+      EOF
+  }
+  ```
 
 1. Embed the "Open in Coder" button with Markdown
 
