8000 fix(docs): add dotfiles module reference by doodzik · Pull Request #14675 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

fix(docs): add dotfiles module reference #14675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 19, 2024
Merged

fix(docs): add dotfiles module reference #14675

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6dd6404
add dotfiles module reference
doodzik Sep 13, 2024
3d10720
Update docs/dotfiles.md
doodzik Sep 16, 2024
d62df8a
Merge branch 'main' into patch-2
matifali Sep 17, 2024
c421965
Fix markdown line length in dotfiles documentation
matifali Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
add dotfiles module reference
  • Loading branch information
@doodzik
doodzik authored Sep 13, 2024
commit 6dd640468097ac2509ce428a1c03d98ad5d1498f
15 changes: 15 additions & 0 deletions docs/dotfiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading
0