Skip to content

docs: Add Quickstart part 2 (Customize workspace startup)#26275

Open
nickvigilante wants to merge 4 commits into
mainfrom
nick/quickstart-part-2
Open

docs: Add Quickstart part 2 (Customize workspace startup)#26275
nickvigilante wants to merge 4 commits into
mainfrom
nick/quickstart-part-2

Conversation

@nickvigilante

Copy link
Copy Markdown
Contributor

This PR adds the Quickstart Part 2 docs: Customize workspace startup.

What this guide accomplishes: Edit the Quickstart template to add a new programming language (Ruby), enable automatic dotfiles installation, and gate workspace creation on GitHub authentication for seamless private-repo cloning. Optional bonus sections add a workspace metadata widget, a custom workspace app, and a new preset.

Approximate time: 20-30 minutes for the three main enhancements. Add ~10-15 min if the reader attempts the bonus sections.

Why this belongs in the series: This is where the reader learns that templates are editable artifacts, not fixed infrastructure. They practice the three highest-leverage Terraform patterns in any Coder template: editing existing coder_parameter blocks, pulling registry modules, and declaring data sources for their side effects. Without this part, readers never see HCL and never understand the relationship between the template file and what their workspace becomes.

@nickvigilante nickvigilante requested a review from bpmct June 11, 2026 17:50
@github-actions

Copy link
Copy Markdown

Docs preview

📖 View docs preview for docs/tutorials/quickstart/customize-workspace-startup.md

@coder-tasks

coder-tasks Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Documentation Check

Updates Needed

  • docs/manifest.json - The first Quickstart entry (with children) still uses path ./tutorials/quickstart.md, but the file was moved to ./tutorials/quickstart/index.md. The second Quickstart entry was correctly updated to ./tutorials/quickstart/index.md. Both entries should use the same index.md path to match the convention used by other directory-based entries (Support, Install, Cloud Providers, Releases).
  • docs/tutorials/quickstart/customize-workspace-startup.md - Step 4 has a duplicate line: push a new version of your template: appears twice in succession.

Previously Reported (Resolved)

  • docs/tutorials/quickstart/customize-workspace-startup.md - Missing Steps 3-4 (Dotfiles module, external auth) Now includes all 4 steps
  • docs/tutorials/quickstart/index.md - Broken link to Part 3 ./add-custom-workspace-tools.md Part 3 reference removed

Automated review via Coder Agents

@nickvigilante nickvigilante marked this pull request as draft June 11, 2026 17:55
@nickvigilante

Copy link
Copy Markdown
Contributor Author

@bpmct This is now ready for review!

@bpmct bpmct marked this pull request as ready for review June 11, 2026 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant