Skip to content

Create new hub repository for modules/templates/future Coder resources #530

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

Closed
f0ssel opened this issue Mar 26, 2025 · 0 comments · Fixed by coder/registry#1
Closed

Create new hub repository for modules/templates/future Coder resources #530

f0ssel opened this issue Mar 26, 2025 · 0 comments · Fixed by coder/registry#1
Assignees

Comments

@f0ssel
Copy link

f0ssel commented Mar 26, 2025

We've decided that we're going to create a monorepo for holding all templates, modules, user profiles (particularly partners), and any other Coder resource types that can receive open-source contributions.

The specific name of the repo isn't 100% final, but we think that this directory structure makes the most sense and has the best tradeoffs:

repository-root/
├── hub/
|   ├── matifali/
|   |   ├─ README.md
|   |   ├─ modules/
|   |   |  ├── airflow/
|   |   |  └── jetbrains/
|   |   ├─ templates/
|   |   |  ├── azure_vm/
|   |   |  └── aws_ec2/
|   |   └─ other_resource_types_in_the_future/
|   ├── nataindata/
|   |   ├─ README.md
|   |   ├─ modules/
|   |   ├─ templates/
|   |   └─ other_resource_types_in_the_future/
|   └── etc/
|       ├─ modules/
|       ├─ templates/
|       └─ other_resource_types_in_the_future/
├── testing/
|   └─ put_general_testing_helpers_here/
├── ci/
|   └─ put_all_ci_stuff here/
└── .logos

The idea is that there would be one main top-level directory (tentatively named hub), and directly inside that would be a set of user directories:

  • A user is free to contribute their own directory
  • Inside each user directory would be a number of subdirectories, one for each resource type. We would be launching with support for a modules subdirectory and a templates subdirectory
  • Each user directory must include a README.md file. This file would define metadata about who the user is, which would then be rendered in the Registry site as a profile page.

Each README must include frontmatter that follows a specific schema. There is another issue for adding CI to validate the structure of each schema. The current schema proposal looks like this:

# User Profile Schema
---
display_name: Atif Ali # required
bio: # optional
avatar: https://github.com/matifali.png # optional, use GitHub avatar if not specified or can be URL
github: matifali # required
linkedin: ioatif # optional
website: https://matifali.dev # optional for individuals
company: # optional, reference to a company profile
email: # optioanl contact email
status: community # options: official | partner | community (default: community if not specified)
---
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants