mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
docs: add a Customize your template series under Get started (#26712)
## What Adds a **Customize your template** series under the top-level **Get started** section, at `docs/get-started/customize-your-template/`. These guides extend the single-page Quickstart (added in #26821) with hands-on template customization: - **Add a programming language** — expose a language through a parameter, install it at startup, and offer it as a preset. - **Install your own command-line tools** — install personal tools with Homebrew and mise, and make them persist. - **Clone private repositories** — authenticate workspaces to GitHub with an external-auth data source. ## Changes from the earlier draft This branch was rebased onto the consolidated `/docs/get-started` structure: - Re-homed the series from `tutorials/quickstart/` to `get-started/customize-your-template/`, nested under the new Get started section. - Dropped the Part 1 launch page and the old landing page; the merged Quickstart (`get-started/index.md`, #26821) already covers them. - Archived the dotfiles guide out of the series (tracked as a follow-up to document the dotfiles module as a standalone tutorial) and removed its inbound links. - Renamed the section to **Customize your template**. - Added a Ruby **preset** alongside the Ruby parameter so the parameter and preset choices stay in sync. - Fixed the parameter-change steps to route through **Workspace settings > Parameters**. - Gave each page a **What's next?** step so the series reads as a sequence. ## Still open / follow-ups - Screenshots for the UI steps (handled separately). - The launch step will be revised after the template-builder change ships in the next mainline release. <details> <summary>Decision log</summary> - **Why re-home, not keep `tutorials/quickstart/`:** the Quickstart now lives at `/docs/get-started`, so the series belongs under the same top-level section for a single, coherent entry point. - **Why drop Part 1 here:** the launch content already merged as `get-started/index.md` in #26821; keeping a second copy would duplicate and drift. - **Why archive dotfiles:** it works better as a standalone module tutorial than as a Quickstart step; removed from the series for now and tracked for later. - **Final code fixtures** stay scoped per guide (base template plus that page's edit), so only the language guide's fixture gains the Ruby option and preset. </details> --- Generated by Coder Agents on behalf of @nickvigilante.
This commit is contained in:
Nick Vigilante
+38
-33
@@ -231,7 +231,7 @@ Templates define what's in your development environment. The following is a basi
|
||||
|
||||
4. Select **Save**.
|
||||
|
||||
|
||||
|
||||
|
||||
**What just happened?**
|
||||
You defined a template, a reusable blueprint for dev environments, in your Coder deployment.
|
||||
@@ -264,6 +264,8 @@ Now it's time to launch a workspace.
|
||||
|
||||
**Note:** If you use any of the JetBrains IDEs as your preferred IDE (such as PyCharm, GoLand, or RustRover), select **JetBrains IDEs** as the value. A new parameter will appear, with which you can choose your preferred JetBrains IDE.
|
||||
|
||||
_Workspace creation screen_
|
||||
|
||||
4. Launch your workspace by selecting **Create workspace**.
|
||||
|
||||
After a short wait (10-15 seconds on most modern computers), Coder will start your new workspace:
|
||||
@@ -305,7 +307,7 @@ workspace, you can clone it manually if you want:
|
||||
|
||||
4. You are now using VS Code in your Coder environment!
|
||||
|
||||
## Success! You're coding in Coder
|
||||
## What's next?
|
||||
|
||||
You now have:
|
||||
|
||||
@@ -314,10 +316,9 @@ You now have:
|
||||
- A workspace running that environment.
|
||||
- IDE access to code remotely.
|
||||
|
||||
### What's next?
|
||||
Now that you have your own workspace running, you can [customize your template](./customize-your-template/index.md) to fit your needs.
|
||||
|
||||
Now that you have your own workspace running, you can start exploring more
|
||||
advanced capabilities that Coder offers.
|
||||
## Learn more
|
||||
|
||||
- [Try Coder Agents](../ai-coder/agents/getting-started.md), the chat
|
||||
interface and API for delegating development work to coding agents in your
|
||||
@@ -346,34 +347,6 @@ In that case, point Coder at the socket with the `DOCKER_HOST` environment varia
|
||||
|
||||
<div class="tabs">
|
||||
|
||||
#### macOS
|
||||
|
||||
1. If Colima is not installed, install it with [Homebrew](https://brew.sh):
|
||||
|
||||
```sh
|
||||
brew install colima docker
|
||||
```
|
||||
|
||||
1. Start Colima to launch the Docker daemon:
|
||||
|
||||
```sh
|
||||
colima start
|
||||
```
|
||||
|
||||
1. Verify that the daemon is reachable:
|
||||
|
||||
```sh
|
||||
docker ps
|
||||
```
|
||||
|
||||
1. If `docker ps` works but Coder still cannot connect, point `DOCKER_HOST` at the Colima socket, then restart the Coder server:
|
||||
|
||||
```sh
|
||||
export DOCKER_HOST="unix://${HOME}/.colima/default/docker.sock"
|
||||
```
|
||||
|
||||
To persist the setting across restarts, add that `export` line to your shell's startup file, such as `~/.zshrc`, `~/.bashrc`, or `~/.config/fish/config.fish`.
|
||||
|
||||
#### Linux
|
||||
|
||||
1. Install Docker, if you haven't already:
|
||||
@@ -403,6 +376,34 @@ In that case, point Coder at the socket with the `DOCKER_HOST` environment varia
|
||||
docker sudo users
|
||||
```
|
||||
|
||||
#### macOS
|
||||
|
||||
1. If Colima is not installed, install it with [Homebrew](https://brew.sh):
|
||||
|
||||
```sh
|
||||
brew install colima docker
|
||||
```
|
||||
|
||||
1. Start Colima to launch the Docker daemon:
|
||||
|
||||
```sh
|
||||
colima start
|
||||
```
|
||||
|
||||
1. Verify that the daemon is reachable:
|
||||
|
||||
```sh
|
||||
docker ps
|
||||
```
|
||||
|
||||
1. If `docker ps` works but Coder still cannot connect, point `DOCKER_HOST` at the Colima socket, then restart the Coder server:
|
||||
|
||||
```sh
|
||||
export DOCKER_HOST="unix://${HOME}/.colima/default/docker.sock"
|
||||
```
|
||||
|
||||
To persist the setting across restarts, add that `export` line to your shell's startup file, such as `~/.zshrc`, `~/.bashrc`, or `~/.config/fish/config.fish`.
|
||||
|
||||
#### Windows
|
||||
|
||||
1. If Podman Desktop is not installed,
|
||||
@@ -422,6 +423,8 @@ error: configure http(s): listen tcp 127.0.0.1:3000: bind: address already in us
|
||||
Another process is already listening on port 3000. Identify and stop it,
|
||||
then start the server again.
|
||||
|
||||
<div class="tabs">
|
||||
|
||||
#### Linux
|
||||
|
||||
1. Stop the process:
|
||||
@@ -481,3 +484,5 @@ then start the server again.
|
||||
```sh
|
||||
coder server
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user