docs: add documentation for modules in contributing #18597
Conversation
|
Can you add a diagram describing how a module fits into Cider architecture? Also I would suggest being lean on the module usage section i.e. example uses, and more detailed on how to write the module and what is the significance of each type of resource an author can add to the module. What are those sources provided. Here we can also consider examples like what will be needed to write a module to:
In these we can also link existing matching module implementations as examples. |
|
Okay I had those exact examples in my registry version so I'll clean up and add these to the contributing doc and take into account the rest of your points as well 👌 |
| } | ||
| ``` | ||
|
|
||
| #### coder_app - User Interface |
There was a problem hiding this comment.
I suggest adding some screenshots in sections like this!
There was a problem hiding this comment.
Any thoughts on specific modules to showcase?
I was thinking about doing this but i'm not sure which would be the best to display since most of these would be huge browser windows.
…per, Desktop, AI, Integration, and Web-based Tools and remove duplicate explanation from end of doc.
Co-authored-by: Atif Ali <[email protected]>
…ced resource links for better clarity addressed all comments up to commit time aside from unresolved comments awaiting replies
Co-authored-by: Atif Ali <[email protected]>
Co-authored-by: Atif Ali <[email protected]>
Co-authored-by: Atif Ali <[email protected]>
…d and desktop IDEs for clarity
…n contributing guide
…d workspace enhancement modules sections
| } | ||
| ``` | ||
|
|
||
| > **⚠️ Important**: Health check URLs are service-specific. Common paths include `/health`, `/healthz`, `/ping`, `/status`, or `/api/health`. Check your service's documentation or use the main service URL if no dedicated health endpoint exists. |
| Example: | ||
|
|
||
| ```tf | ||
| resource "coder_env" "config" { |
There was a problem hiding this comment.
Use a different example. Something like VAUKT_ADDR or VAULT_TOKEN
| # Provides: name, email, full_name, groups of the workspace owner. | ||
| ``` | ||
|
|
||
| ### Variable Design |
There was a problem hiding this comment.
Why is it called design? Maybe we call it Module Inputs variable types. Also this is a terraform concept and not Coder so should also be able to link to some upstream docs.
| } | ||
| ``` | ||
|
|
||
| ### Script Development |
There was a problem hiding this comment.
Same comment. I think we should drop the words Development and use an action sentence like "Running Scripts"
Let me know if this align's with what you were looking for in this modules doc. @matifali