docs: fix formatting of note callouts (coder#16761)

lucasmelin · web-flow · commit db064ed0f8f4 · 2025-03-07T10:35:14.000-05:00
Fixes the formatting of several note callouts. Previously, these would render incorrectly both on GitHub and on the documentation site.
diff --git a/docs/admin/provisioners.md b/docs/admin/provisioners.md
@@ -166,7 +166,8 @@ inside the Terraform. See the
 [workspace tags documentation](../admin/templates/extending-templates/workspace-tags.md)
 for more information.
 
-> [!NOTE] Workspace tags defined with the `coder_workspace_tags` data source
+> [!NOTE]
+> Workspace tags defined with the `coder_workspace_tags` data source
 > template **do not** automatically apply to the template import job! You may
 > need to specify the desired tags when importing the template.
 
@@ -190,7 +191,8 @@ However, it will not pick up any build jobs that do not have either of the
 from templates with the tag `scope=user` set, or build jobs from templates in
 different organizations.
 
-> [!NOTE] If you only run tagged provisioners, you will need to specify a set of
+> [!NOTE]
+> If you only run tagged provisioners, you will need to specify a set of
 > tags that matches at least one provisioner for _all_ template import jobs and
 > workspace build jobs.
 >
diff --git a/docs/admin/templates/extending-templates/parameters.md b/docs/admin/templates/extending-templates/parameters.md
@@ -79,7 +79,8 @@ data "coder_parameter" "security_groups" {
 }
 ```
 
-> [!NOTE] Overriding a `list(string)` on the CLI is tricky because:
+> [!NOTE]
+> Overriding a `list(string)` on the CLI is tricky because:
 >
 > - `--parameter "parameter_name=parameter_value"` is parsed as CSV.
 > - `parameter_value` is parsed as JSON.
diff --git a/examples/examples.gen.json b/examples/examples.gen.json
diff --git a/examples/templates/aws-devcontainer/README.md b/examples/templates/aws-devcontainer/README.md
@@ -96,7 +96,8 @@ When creating the template, set the parameter `cache_repo` to a valid Docker rep
 
 See the [Envbuilder Terraform Provider Examples](https://github.com/coder/terraform-provider-envbuilder/blob/main/examples/resources/envbuilder_cached_image/envbuilder_cached_image_resource.tf/) for a more complete example of how the provider works.
 
-> [!NOTE] We recommend using a registry cache with authentication enabled.
+> [!NOTE]
+> We recommend using a registry cache with authentication enabled.
 > To allow Envbuilder to authenticate with a registry cache hosted on ECR, specify an IAM instance
 > profile that has read and write access to the given registry. For more information, see the
 > [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).
diff --git a/examples/templates/docker-devcontainer/README.md b/examples/templates/docker-devcontainer/README.md
@@ -71,6 +71,7 @@ Then, when creating the template, enter `localhost:5000/devcontainer-cache` for
 
 See the [Envbuilder Terraform Provider Examples](https://github.com/coder/terraform-provider-envbuilder/blob/main/examples/resources/envbuilder_cached_image/envbuilder_cached_image_resource.tf/) for a more complete example of how the provider works.
 
-> [!NOTE] We recommend using a registry cache with authentication enabled.
+> [!NOTE]
+> We recommend using a registry cache with authentication enabled.
 > To allow Envbuilder to authenticate with the registry cache, specify the variable `cache_repo_docker_config_path`
 > with the path to a Docker config `.json` on disk containing valid credentials for the registry.
diff --git a/examples/templates/gcp-devcontainer/README.md b/examples/templates/gcp-devcontainer/README.md
@@ -70,7 +70,8 @@ When creating the template, set the parameter `cache_repo` to a valid Docker rep
 
 See the [Envbuilder Terraform Provider Examples](https://github.com/coder/terraform-provider-envbuilder/blob/main/examples/resources/envbuilder_cached_image/envbuilder_cached_image_resource.tf/) for a more complete example of how the provider works.
 
-> [!NOTE] We recommend using a registry cache with authentication enabled.
+> [!NOTE]
+> We recommend using a registry cache with authentication enabled.
 > To allow Envbuilder to authenticate with the registry cache, specify the variable `cache_repo_docker_config_path`
 > with the path to a Docker config `.json` on disk containing valid credentials for the registry.
 
diff --git a/examples/templates/kubernetes-devcontainer/README.md b/examples/templates/kubernetes-devcontainer/README.md
@@ -52,6 +52,7 @@ When creating the template, set the parameter `cache_repo`.
 
 See the [Envbuilder Terraform Provider Examples](https://github.com/coder/terraform-provider-envbuilder/blob/main/examples/resources/envbuilder_cached_image/envbuilder_cached_image_resource.tf/) for a more complete example of how the provider works.
 
-> [!NOTE] We recommend using a registry cache with authentication enabled.
+> [!NOTE]
+> We recommend using a registry cache with authentication enabled.
 > To allow Envbuilder to authenticate with the registry cache, specify the variable `cache_repo_dockerconfig_secret`
 > with the name of a Kubernetes secret in the same namespace as Coder. The secret must contain the key `.dockerconfigjson`.

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,8 @@ data "coder_parameter" "security_groups" {`
`79`	`79`	`}`
`80`	`80`	```
`81`	`81`
`82`		-> [!NOTE] Overriding a `list(string)` on the CLI is tricky because:
	`82`	`+> [!NOTE]`
	`83`	+> Overriding a `list(string)` on the CLI is tricky because:
`83`	`84`	`>`
`84`	`85`	> - `--parameter "parameter_name=parameter_value"` is parsed as CSV.
`85`	`86`	> - `parameter_value` is parsed as JSON.