dotfiles page done

stirby · matifali · commit 39185edc8f3d · 2024-08-12T17:01:25.000+03:00
diff --git a/docs/images/user-guides/dotfiles-module.png b/docs/images/user-guides/dotfiles-module.png
diff --git a/docs/user-guides/README.md b/docs/user-guides/README.md
@@ -58,11 +58,10 @@ The following filters are supported:
   statuses, see
   [WorkspaceStatus documentation](https://pkg.go.dev/github.com/coder/coder/codersdk#WorkspaceStatus).
 
-
 ## Updating workspaces
 
 After updating the default version of the template that a workspace was created
-from, you can update the workspace. 
+from, you can update the workspace.
 
 ![Updating a workspace](../../images/workspace-update.png)
 
@@ -87,10 +86,9 @@ manually updated the workspace.
 
 ![Automatic Updates](./images/workspace-automatic-updates.png)
 
-
 ### Update policies
 
-Template admins can require workspaces be on the latest version before starting. When this is enabled, you will be presented with an "Update and Start" button in the UI. Workspaces that start on connect will automatically update on the first out-of-date connection. 
+Template admins can require workspaces be on the latest version before starting. When this is enabled, you will be presented with an "Update and Start" button in the UI. Workspaces that start on connect will automatically update on the first out-of-date connection.
 
 ## Bulk operations (enterprise)
 
diff --git a/docs/user-guides/workspace-dotfiles.md b/docs/user-guides/workspace-dotfiles.md
@@ -1,6 +1,74 @@
-# Personalize your workspace
+# Dotfiles
 
-TODO:
+<!-- markdown-link-check-disable -->
 
-- dotfiles
-- idk
+Coder offers the `coder dotfiles <repo>` command which simplifies workspace
+personalization. Our behavior is consistent with Codespaces, so
+[their documentation](https://docs.github.com/en/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#dotfiles)
+explains how it loads your repo.
+
+<!-- markdown-link-check-enable -->
+
+You can read more on dotfiles best practices [here](https://dotfiles.github.io).
+
+## From templates
+
+Templates can prompt users for their dotfiles repo URL, which will personalize
+your workspace automatically.
+
+![Dotfiles in workspace creation](../images/user-guides/dotfiles-module.png)
+
+<!-- TODO: Template management docs link-->
+
+> Template admins: this can be enabled quite easily with a our
+> [dotfiles module](https://registry.coder.com/modules/dotfiles) using just a
+> few lines in the template.
+
+## Personalize script
+
+Templates may be configured to support executing a `~/personalize` script on
+startup which users can populate with commands to customize their workspaces.
+
+You can even fill `personalize` with `coder dotfiles <repo>`, but those looking
+for a simpler approach can inline commands like so:
+
+```bash
+#!/bin/bash
+sudo apt update
+# Install some of my favorite tools every time my workspace boots
+sudo apt install -y neovim fish cargo
+```
+
+<!-- TODO: template admin docs link -->
+
+> Template admins: read the docs on how to enable the `~/personalize` script on
+> templates.
+
+## Setup script support
+
+User can setup their dotfiles by creating one of the following script files in
+their dotfiles repo:
+
+- `install.sh`
+- `install`
+- `bootstrap.sh`
+- `bootstrap`
+- `script/bootstrap`
+- `setup.sh`
+- `setup`
+- `script/setup`
+
+If any of the above files are found (in the specified order), Coder will try to
+execute the first match. After the first match is found, other files will be
+ignored.
+
+The setup script must be executable, otherwise the dotfiles setup will fail. If
+you encounter this issue, you can fix it by making the script executable using
+the following commands:
+
+```shell
+cd <path_to_dotfiles_repo>
+chmod +x <script_name>
+git commit -m "Make <script_name> executable" <script_name>
+git push
+```
diff --git a/docs/user-guides/workspace-scheduling.md b/docs/user-guides/workspace-scheduling.md
@@ -111,5 +111,7 @@ Enterprise admins may also configure failure cleanup, which will autmatically
 delete workspaces that remain in a `failed` state for too long.
 
 ## Next steps
+
 <!-- TODO: Links -->
+
 - Template Scheduling
