-
Notifications
You must be signed in to change notification settings - Fork 8
feat: Add Documentation for Coder Modules #164
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did not reviw in full but this looks overly complex and includes extra details Please focus on the resources whiahc we use mostly.
coder_script
, coder_env
and coder_app
and coder_parameter
etc. For anything advanced we have provider docs.
Also move this to coder/coder repo in main docs.
- **Templates**: Terraform configurations defining workspace infrastructure and module integration | ||
- **Modules**: Reusable components providing specific functionality extensions | ||
- **Registry**: Centralized repository for module discovery and distribution | ||
- **Agents**: Runtime components executing module-defined operations within workspaces |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are your referring to the coder_agent
here?
│ Running development │ | ||
│ environments │ | ||
└─────────────────────────┘ | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please replace with a rendered diagram. You can use tldraw or excalidraw for that.
|
||
**Advanced Resources:** | ||
|
||
- [`coder_agent_instance`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent_instance): Manages agent instance connections |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is very rarely used so can be skipped.
**Current Version Standards:** | ||
|
||
- **Latest Coder Provider**: v2.8.0 (June 2025) | ||
- **Recommended Minimum**: `>= 2.5` (used by most current modules) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- **Recommended Minimum**: `>= 2.5` (used by most current modules) | |
- **Recommended Minimum**: `>= 2.5` (used by most current modules) |
There is no recommended version. It always depends on the feature you are using in your module and the minimum version of the provider where that feature is available.
- **Recommended Minimum**: `>= 2.5` (used by most current modules) | ||
- **Legacy Modules**: Some older modules still use lower versions (0.12+) but should be updated when possible | ||
|
||
New modules should use `>= 2.5` to ensure access to modern features like app groups, prebuilt workspaces, and improved validation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New modules should use `>= 2.5` to ensure access to modern features like app groups, prebuilt workspaces, and improved validation. | |
New modules should use `>= 2.5` to ensure access to modern features like app groups, prebuilt workspaces, and improved validation. |
Again 8000 , we should not recommend 2.5; maybe we can recommend 2.0, as that is our current major release, or remove this line in favor of explaining the minimum version.
Co-authored-by: Atif Ali <atif@coder.com>
Co-authored-by: Atif Ali <atif@coder.com>
Co-authored-by: Atif Ali <atif@coder.com>
Description
Initial Commit of Documentation for Coder Modules
Need review from @matifali
Type of Change