opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix formatting of note callouts (#16761)

Browse Source 
Fixes the formatting of several note callouts. Previously, these would render incorrectly both on GitHub and on the documentation site.
This commit is contained in:
Lucas Melin
2025-03-07 10:35:14 -05:00
committed by GitHub
parent 17f8e93d0c
commit db064ed0f8
7 changed files with 18 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/templates/aws-devcontainer/README.md
+2 -1
View File
@@ -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).
examples/templates/docker-devcontainer/README.md
+2 -1
View File
@@ -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.
examples/templates/gcp-devcontainer/README.md
+2 -1
View File
@@ -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.
examples/templates/kubernetes-devcontainer/README.md
+2 -1
View File
@@ -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`.