Skip to content

Commit c9ddb08

Browse files
docs(contributing): update all frontmatter fields in both docs and address other issues
1 parent d274157 commit c9ddb08

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

docs/about/contributing/modules.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ github: "your-username"
7373
avatar: "./.images/avatar.png"
7474
linkedin: "https://www.linkedin.com/in/your-username"
7575
website: "https://your-website.com"
76+
support_email: "support@your-domain.com"
7677
status: "community"
7778
---
7879

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

8485
> [!NOTE]
85-
> The `linkedin` and `website` fields are optional and can be omitted or left empty if not applicable.
86+
> The `linkedin`, `website`, and `support_email` fields are optional and can be omitted or left empty if not applicable.
8687
8788
### 2. Generate module scaffolding
8889

docs/about/contributing/templates.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,11 @@ Create your namespace README at `registry/[your-username]/README.md`:
7171
---
7272
display_name: "Your Name"
7373
bio: "Brief description of what you do"
74-
avatar_url: "./.images/avatar.png"
7574
github: "your-username"
75+
avatar: "./.images/avatar.png"
76+
linkedin: "https://www.linkedin.com/in/your-username"
77+
website: "https://your-website.com"
78+
support_email: "support@your-domain.com"
7679
status: "community"
7780
---
7881

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

87+
> [!NOTE]
88+
> The `linkedin`, `website`, and `support_email` fields are optional and can be omitted or left empty if not applicable.
89+
8490
### 2. Create your template directory
8591

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

197202
## Features
198203

199-
- **Ubuntu 20.04 LTS** base image
204+
- **Ubuntu 24.04 LTS** base image
200205
- **VS Code** with code-server for browser-based development
201206
- **Git** with automatic repository cloning
202207
- **Node.js** and **npm** for JavaScript development
@@ -297,7 +302,7 @@ module "dotfiles" {
297302
}
298303
```
299304

300-
### Variable design
305+
### Variables
301306

302307
Provide meaningful customization options:
303308

@@ -434,7 +439,7 @@ When modifying existing templates:
434439
# Simple Docker template
435440
resource "docker_container" "workspace" {
436441
count = data.coder_workspace.me.start_count
437-
image = "ubuntu:20.04"
442+
image = "ubuntu:24.04"
438443
name = "coder-${data.coder_workspace_owner.me.name}-${data.coder_workspace.me.name}"
439444
440445
command = ["sh", "-c", coder_agent.main.init_script]
@@ -473,7 +478,7 @@ resource "kubernetes_pod" "workspace" {
473478
spec {
474479
container {
475480
name = "workspace"
476-
image = "ubuntu:20.04"
481+
image = "ubuntu:24.04"
477482
478483
command = ["sh", "-c", coder_agent.main.init_script]
479484
env {

0 commit comments

Comments
 (0)