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

docs: add documentation for modules in contributing#18597

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Draft
DevelopmentCats wants to merge21 commits intomain
base:main
Choose a base branch
Loading
fromcat/modules-doc

Conversation

DevelopmentCats
Copy link
Contributor

Let me know if this align's with what you were looking for in this modules doc.@matifali

@DevelopmentCatsDevelopmentCats added the docsArea: coder.com/docs labelJun 26, 2025
@DevelopmentCatsDevelopmentCats changed the titlefeat: Add Coder Documentation for Contributing docsdocs: Add Coder Documentation for Contributing docsJun 26, 2025
@DevelopmentCatsDevelopmentCats changed the titledocs: Add Coder Documentation for Contributing docsdocs: add modules documentation for contributing docsJun 26, 2025
@DevelopmentCatsDevelopmentCats changed the titledocs: add modules documentation for contributing docsdocs: add documentation for modules in contributingJun 26, 2025
@DevelopmentCatsDevelopmentCats marked this pull request as draftJune 26, 2025 02:34
@matifali
Copy link
Member

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:

  • Enable an external ide integration.
  • Enable an externality auth with a service by installing CLI binary ir injecting some env variable
  • Writing some configuration files.
  • Install a VSCode extension?

In these we can also link existing matching module implementations as examples.

DevelopmentCats reacted with thumbs up emoji

@DevelopmentCats
Copy link
ContributorAuthor

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I suggest adding some screenshots in sections like this!

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

DevelopmentCatsand others added6 commitsJune 26, 2025 18:49
…per, Desktop, AI, Integration, and Web-based Tools and remove duplicate explanation from end of doc.
Co-authored-by: Atif Ali <atif@coder.com>
…ced resource links for better clarityaddressed all comments up to commit time aside from unresolved comments awaiting replies
Copy link
Member

@matifalimatifali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I did another pass and it looks way better now. Please address comments.

DevelopmentCatsand others added2 commitsJune 27, 2025 08:52
Co-authored-by: Atif Ali <atif@coder.com>
Co-authored-by: Atif Ali <atif@coder.com>
}
```

> **⚠️ 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Use GFM style

Example:

```tf
resource "coder_env" "config" {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Use a different example. Something likeVAUKT_ADDR orVAULT_TOKEN

# Provides: name, email, full_name, groups of the workspace owner.
```

### Variable Design
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Same comment. I think we should drop the words Development and use an action sentence like "Running Scripts"

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@matifalimatifalimatifali requested changes

@bpmctbpmctbpmct left review comments

Requested changes must be addressed to merge this pull request.

Assignees

@DevelopmentCatsDevelopmentCats

Labels
docsArea: coder.com/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@DevelopmentCats@matifali@bpmct
[8]ページ先頭
©2009-2025 Movatter.jp