Skip to content

docs: add contribution documentation for modules and templates #18820

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.

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 23 commits into from
Jul 17, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
fb1d650
docs: add contributing guideline docs for modules and templates
DevelopmentCats Jul 8, 2025
5238467
docs: move and update detailed contributing guidelines for modules an…
DevelopmentCats Jul 10, 2025
c692a8a
docs: update module contribution guidelines and remove redundant content
DevelopmentCats Jul 10, 2025
bd1df6b
docs: remove redundant label from registry description
DevelopmentCats Jul 11, 2025
a3bd628
docs: add new sections for contributing modules and templates in the …
DevelopmentCats Jul 11, 2025
5a74ceb
docs: remove unnecessary whitespace in module contribution guidelines
DevelopmentCats Jul 11, 2025
fbc9837
Merge branch 'main' into cat/contrib-docs
DevelopmentCats Jul 11, 2025
aaa5fe1
Update docs/about/contributing/modules.md
DevelopmentCats Jul 12, 2025
df66bf2
docs(modules): split ide's into web and desktop with examples
DevelopmentCats Jul 12, 2025
38db529
docs(modules): update examples for development tools and workspace ut…
DevelopmentCats Jul 12, 2025
a78c04f
docs(modules): update alerts to all match GFM style
DevelopmentCats Jul 12, 2025
e280608
docs(modules): simplify version bump instructions in contribution gui…
DevelopmentCats Jul 12, 2025
867c60d
docs(modules): remove outdated troubleshooting tips from contribution…
DevelopmentCats Jul 12, 2025
7cb96d8
docs(modules): remove redundant common issues
DevelopmentCats Jul 12, 2025
d274157
docs(modules): update reference module links in contribution guidelines
DevelopmentCats Jul 12, 2025
c9ddb08
docs(contributing): update all frontmatter fields in both docs and ad…
DevelopmentCats Jul 12, 2025
132d499
docs(contributing): remove redundant template issues and remove over …
DevelopmentCats Jul 12, 2025
b9b548d
docs(contributing): update examples section with links to official Co…
DevelopmentCats Jul 12, 2025
6099665
docs(contributing): update issue reporting instructions to include di…
DevelopmentCats Jul 12, 2025
d998ba4
Merge branch 'main' into cat/contrib-docs
DevelopmentCats Jul 12, 2025
2ec825a
docs(contributing): update module examples with new versions agent ID…
DevelopmentCats Jul 15, 2025
ca4654f
docs(contributing): update module examples section to replace 'Develo…
DevelopmentCats Jul 15, 2025
b730042
Merge branch 'main' into cat/contrib-docs
DevelopmentCats Jul 15, 2025
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
Prev Previous commit
Next Next commit
docs(contributing): update all frontmatter fields in both docs and ad…
…dress other issues
  • Loading branch information
DevelopmentCats committed Jul 12, 2025
commit c9ddb0885ded73dd3894ac4402153773bf07ec45
3 changes: 2 additions & 1 deletion docs/about/contributing/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ github: "your-username"
avatar: "./.images/avatar.png"
linkedin: "https://www.linkedin.com/in/your-username"
website: "https://your-website.com"
support_email: "support@your-domain.com"
status: "community"
---

Expand All @@ -82,7 +83,7 @@ Brief description of who you are and what you do.
```

> [!NOTE]
> The `linkedin` and `website` fields are optional and can be omitted or left empty if not applicable.
> The `linkedin`, `website`, and `support_email` fields are optional and can be omitted or left empty if not applicable.

### 2. Generate module scaffolding

Expand Down
17 changes: 11 additions & 6 deletions docs/about/contributing/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,11 @@ Create your namespace README at `registry/[your-username]/README.md`:
---
display_name: "Your Name"
bio: "Brief description of what you do"
avatar_url: "./.images/avatar.png"
github: "your-username"
avatar: "./.images/avatar.png"
linkedin: "https://www.linkedin.com/in/your-username"
website: "https://your-website.com"
support_email: "support@your-domain.com"
status: "community"
---

Expand All @@ -81,6 +84,9 @@ status: "community"
Brief description of who you are and what you do.
```

> [!NOTE]
> The `linkedin`, `website`, and `support_email` fields are optional and can be omitted or left empty if not applicable.

### 2. Create your template directory

Create a directory for your template:
Expand Down Expand Up @@ -185,7 +191,6 @@ Create `README.md` with comprehensive documentation:
display_name: "Ubuntu Development Environment"
description: "Complete Ubuntu workspace with VS Code, Git, and development tools"
icon: "../../../../.icons/ubuntu.svg"
maintainer_github: "your-username"
verified: false
tags: ["ubuntu", "docker", "vscode", "git"]
---
Expand All @@ -196,7 +201,7 @@ A complete Ubuntu-based development workspace with VS Code, Git, and essential d

## Features

- **Ubuntu 20.04 LTS** base image
- **Ubuntu 24.04 LTS** base image
- **VS Code** with code-server for browser-based development
- **Git** with automatic repository cloning
- **Node.js** and **npm** for JavaScript development
Expand Down Expand Up @@ -297,7 +302,7 @@ module "dotfiles" {
}
```

### Variable design
### Variables

Provide meaningful customization options:

Expand Down Expand Up @@ -434,7 +439,7 @@ When modifying existing templates:
# Simple Docker template
resource "docker_container" "workspace" {
count = data.coder_workspace.me.start_count
image = "ubuntu:20.04"
image = "ubuntu:24.04"
name = "coder-${data.coder_workspace_owner.me.name}-${data.coder_workspace.me.name}"

command = ["sh", "-c", coder_agent.main.init_script]
Expand Down Expand Up @@ -473,7 +478,7 @@ resource "kubernetes_pod" "workspace" {
spec {
container {
name = "workspace"
image = "ubuntu:20.04"
image = "ubuntu:24.04"

command = ["sh", "-c", coder_agent.main.init_script]
env {
Expand Down