Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit8943003

Browse files
docs(modules): replace mermaid code with png and enhance parameter and workspace enhancement modules sections
1 parent5355caf commit8943003

File tree

2 files changed

+16
-74
lines changed

2 files changed

+16
-74
lines changed

‎docs/about/contributing/modules.md‎

Lines changed: 16 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -17,74 +17,7 @@ For hands-on learning, try the [Terraform tutorials](https://developer.hashicorp
1717

1818
Understanding how modules fit into the Coder ecosystem:
1919

20-
```mermaid
21-
flowchart LR
22-
subgraph Registry["🌐 Module Registry"]
23-
ModuleCode["📦 Modules<br/>Terraform configurations<br/>with coder resources"]
24-
StarterTemplates["📋 Starter Templates<br/>Infrastructure-specific bases<br/>(Docker, AWS, GCP, etc.)"]
25-
end
26-
27-
subgraph CoderInstance["🏢 Your Coder Instance"]
28-
Template["📄 Template<br/>References modules<br/>from registry"]
29-
30-
subgraph ModuleResources["🔧 Module Resources"]
31-
Script["📜 coder_script<br/>Installation scripts"]
32-
App["🖥️ coder_app<br/>UI applications"]
33-
Env["🌍 coder_env<br/>Environment variables"]
34-
end
35-
end
36-
37-
subgraph Workspace["💻 Developer Workspace"]
38-
Agent["🤖 Coder Agent"]
39-
40-
subgraph Results["Results"]
41-
Tools["🛠️ Installed Tools<br/>IDEs, CLIs, Services"]
42-
Apps["📱 Accessible Apps<br/>Web interfaces"]
43-
Environment["⚙️ Configured Environment<br/>Variables, paths, settings"]
44-
end
45-
end
46-
47-
%% Module flow
48-
ModuleCode -->|"&nbsp;Referenced by&nbsp;"| Template
49-
StarterTemplates -->|"&nbsp;Used as base for&nbsp;"| Template
50-
51-
%% Template to resources
52-
Template --> Script
53-
Template --> App
54-
Template --> Env
55-
56-
%% Resources to agent
57-
Script --> Agent
58-
App --> Agent
59-
Env --> Agent
60-
61-
%% Agent to results
62-
Agent --> Tools
63-
Agent --> Apps
64-
Agent --> Environment
65-
66-
%% Styling
67-
style Registry fill:#e8f5e8,stroke:#2e7d32,stroke-width:2px,color:#000000
68-
style ModuleCode fill:#c8e6c9,stroke:#388e3c,stroke-width:2px,color:#000000
69-
style StarterTemplates fill:#c8e6c9,stroke:#388e3c,stroke-width:2px,color:#000000
70-
71-
style CoderInstance fill:#e3f2fd,stroke:#1976d2,stroke-width:2px,color:#000000
72-
style Template fill:#bbdefb,stroke:#1e88e5,stroke-width:2px,color:#000000
73-
style ModuleResources fill:#90caf9,stroke:#42a5f5,stroke-width:2px,color:#000000
74-
style Script fill:#90caf9,stroke:#42a5f5,stroke-width:1px,color:#000000
75-
style App fill:#90caf9,stroke:#42a5f5,stroke-width:1px,color:#000000
76-
style Env fill:#90caf9,stroke:#42a5f5,stroke-width:1px,color:#000000
77-
78-
style Workspace fill:#fff3e0,stroke:#f57c00,stroke-width:2px,color:#000000
79-
style Agent fill:#ffcc02,stroke:#ff9800,stroke-width:2px,color:#000000
80-
style Results fill:#ffe0b2,stroke:#ffa726,stroke-width:2px,color:#000000
81-
style Tools fill:#ffe0b2,stroke:#ffa726,stroke-width:1px,color:#000000
82-
style Apps fill:#ffe0b2,stroke:#ffa726,stroke-width:1px,color:#000000
83-
style Environment fill:#ffe0b2,stroke:#ffa726,stroke-width:1px,color:#000000
84-
85-
%% Link styling to make arrows visible
86-
linkStyle default stroke:#333333,stroke-width:2px
87-
```
20+
![Module Architecture](../images/modules/module_chart.png)
8821

8922
**How Modules Work in the Coder Ecosystem:**
9023

@@ -99,7 +32,7 @@ flowchart LR
9932

10033
3.**Workspace Execution**: When workspaces are created, the Coder agent handles the Coder-specific additional resources added by the module and provides the extra functionality.
10134
-**Scripts** install and configure tools (IDEs, languages, services)
102-
-**Apps** provide web interfaces accessible through Coder dashboard
35+
-**Apps** provide web interfaces accessible through Coder dashboard
10336
-**Environment** sets up variables, paths, and development settings
10437

10538
**Example Flow**: A template references the`code-server` module → Module adds a`coder_script` to install VS Code and a`coder_app` for browser access → Agent executes the script and serves the app → Developer gets VS Code in their workspace
@@ -134,13 +67,22 @@ One-click launch buttons to connect local IDE applications to your workspace. Th
13467

13568
Simplify template creation and workspace configuration.
13669

70+
####Parameter Modules
71+
72+
Provide user-friendly parameter inputs for template configuration. These modules use`coder_parameter` resources to create dropdown menus and input fields with validation, icons, and human-readable options.
73+
13774
-**[AWS Region](https://registry.coder.com/modules/coder/aws-region)**: A parameter with human region names and icons
13875
-**[Azure Region](https://registry.coder.com/modules/coder/azure-region)**: A parameter with human region names and icons
76+
-**[Fly.io Region](https://registry.coder.com/modules/coder/fly-region)**: A parameter with human region names and icons
77+
-**[GCP Region](https://registry.coder.com/modules/coder/gcp-region)**: Add Google Cloud Platform regions to your Coder template
78+
79+
####Workspace Enhancement Modules
80+
81+
Automate workspace setup and configuration tasks. These modules use`coder_script` to install tools, configure services, or set up development environments during workspace creation.
82+
13983
-**[Coder Login](https://registry.coder.com/modules/coder/coder-login)**: Automatically logs the user into Coder on their workspace
14084
-**[Dotfiles](https://registry.coder.com/modules/coder/dotfiles)**: Allow developers to optionally bring their own dotfiles repository to customize their shell and IDE settings
14185
-**[File Browser](https://registry.coder.com/modules/coder/filebrowser)**: A file browser for your workspace
142-
-**[Fly.io Region](https://registry.coder.com/modules/coder/fly-region)**: A parameter with human region names and icons
143-
-**[GCP Region](https://registry.coder.com/modules/coder/gcp-region)**: Add Google Cloud Platform regions to your Coder template
14486
-**[Git Clone](https://registry.coder.com/modules/coder/git-clone)**: Clone a Git repository by URL and skip if it exists
14587
-**[Git commit signing](https://registry.coder.com/modules/coder/git-commit-signing)**: Configures Git to sign commits using your Coder SSH key
14688
-**[Git Config](https://registry.coder.com/modules/coder/git-config)**: Stores Git configuration from Coder credentials
@@ -277,7 +219,7 @@ resource "coder_app" "service" {
277219
agent_id = var.agent_id
278220
slug = "service"
279221
url = "http://localhost:${var.port}"
280-
222+
281223
healthcheck {
282224
url = "http://localhost:${var.port}/api/status" # Service-specific endpoint
283225
interval = 5
@@ -320,7 +262,7 @@ data "coder_workspace" "me" {}
320262
# Provides: name, id, access_url, start_count
321263
322264
data "coder_workspace_owner" "me" {}
323-
# Provides: name, email, full_name, groups of the workspace owner.
265+
# Provides: name, email, full_name, groups of the workspace owner.
324266
```
325267

326268
###Variable Design
@@ -447,7 +389,7 @@ resource "coder_script" "configure_service" {
447389
resource "coder_app" "service" {
448390
agent_id = var.agent_id
449391
url = "http://localhost:${var.port}"
450-
392+
451393
healthcheck {
452394
url = "http://localhost:${var.port}/health"
453395
interval = 5
277 KB
Loading

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp