From 6dd640468097ac2509ce428a1c03d98ad5d1498f Mon Sep 17 00:00:00 2001 From: Frederik Dudzik <5946811+doodzik@users.noreply.github.com> Date: Fri, 13 Sep 2024 19:47:22 -0400 Subject: [PATCH 1/3] add dotfiles module reference --- docs/dotfiles.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/dotfiles.md b/docs/dotfiles.md index ba5409ccd1537..5124ec9966788 100644 --- a/docs/dotfiles.md +++ b/docs/dotfiles.md @@ -11,6 +11,21 @@ explains how it loads your repo. You can read more on dotfiles best practices [here](https://dotfiles.github.io). +## Module + +Coder's [dotfiles module](https://registry.coder.com/modules/dotfiles) +abstracts Coder's dotfiles command into a module. This will prompt the +user for their dotfiles repository URL on template creation using a +coder_parameter. + +```hcl +module "dotfiles" { + source = "registry.coder.com/modules/dotfiles/coder" + version = "~>1.0.15" + agent_id = coder_agent.example.id +} +``` + ## Templates Templates can prompt users for their dotfiles repo using the following pattern: From 3d10720bb612854de9944df5f9f4bd2381502d57 Mon Sep 17 00:00:00 2001 From: Frederik Dudzik <5946811+doodzik@users.noreply.github.com> Date: Mon, 16 Sep 2024 11:16:05 -0400 Subject: [PATCH 2/3] Update docs/dotfiles.md Co-authored-by: Muhammad Atif Ali --- docs/dotfiles.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dotfiles.md b/docs/dotfiles.md index 5124ec9966788..c6b8bdda1277f 100644 --- a/docs/dotfiles.md +++ b/docs/dotfiles.md @@ -15,7 +15,7 @@ You can read more on dotfiles best practices [here](https://dotfiles.github.io). Coder's [dotfiles module](https://registry.coder.com/modules/dotfiles) abstracts Coder's dotfiles command into a module. This will prompt the -user for their dotfiles repository URL on template creation using a +user for their dotfiles repository URL on workspace creation using a coder_parameter. ```hcl From c421965b5e6489029347486c5142e541817148a5 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Thu, 19 Sep 2024 19:09:06 +0000 Subject: [PATCH 3/3] Fix markdown line length in dotfiles documentation --- docs/dotfiles.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/dotfiles.md b/docs/dotfiles.md index c6b8bdda1277f..5b6e5beb1c60c 100644 --- a/docs/dotfiles.md +++ b/docs/dotfiles.md @@ -13,10 +13,9 @@ You can read more on dotfiles best practices [here](https://dotfiles.github.io). ## Module -Coder's [dotfiles module](https://registry.coder.com/modules/dotfiles) -abstracts Coder's dotfiles command into a module. This will prompt the -user for their dotfiles repository URL on workspace creation using a -coder_parameter. +Coder's [dotfiles module](https://registry.coder.com/modules/dotfiles) abstracts +Coder's dotfiles command into a module. This will prompt the user for their +dotfiles repository URL on workspace creation using a coder_parameter. ```hcl module "dotfiles" {