chore: add all missing README files to repo #85
Conversation
| ```tf | ||
| module "cursor" { | ||
| count = data.coder_workspace.me.start_count | ||
| source = "registry.coder.com/modules/cursor/coder" |
There was a problem hiding this comment.
| source = "registry.coder.com/modules/cursor/coder" | |
| source = "registry.coder.com/coder/cursor/coder" |
Shouldn't it be this now?
There was a problem hiding this comment.
Oh, good call. I ended up copying that snippet directly from the README, but now that you're calling it out, all the current README files still have the old path
@bcpeinhardt Just making sure: I just need to update all the README files to follow the pattern Atif suggested, right? If so, I can go ahead and make a PR to update all the module READMEs
There was a problem hiding this comment.
Yes. The old path will still work, because we've added a shim to avoid breaking peoples workspace builds, but yeah the namespace is now "coder" not "modules"
CONTRIBUTING.md
Outdated
|
|
||
| Once Bun (and possibly Go) have been installed, clone this repository. From there, you can run this script to make it easier to start contributing a new module or template: | ||
| All Coder resources are scoped to namespaces placed at the top level of the `/registry` directory. Any modules or templates must be placed inside a namespace to be accepted as a contribution. For example, all modules created by TheJonkler would be placed under `/registry/thejonkler/modules`, with a subdirectory for each individual module the user has published. |
There was a problem hiding this comment.
Let's use an example that isn't close to anything real just to be safe
CONTRIBUTING.md
Outdated
| - `avatar_url` (optional string) – A relative/absolute URL pointing to your avatar for the Registry site. It is strongly recommended that you commit avatar images to this repo and reference them via a relative URL. | ||
| - `linkedin` (optional string) – A URL pointing to your LinkedIn page. | ||
| - `support_email` (optional string) – An email for users to reach you at if they need help with a published module/template. | ||
| - `status` (optional string union) – If defined, this must be one of `"community"`, `"partner"`, or `"official"`. `"community"` is treated as the default value if not specified, and should be used for the majority of external contributions. `"partner"` is for companies who have a formal business partnership with Coder. `"official"` should be used only by Coder and Coder satellite companies. |
There was a problem hiding this comment.
Instead of an implicit default, can we have an explicit set and fail if missing?
There was a problem hiding this comment.
Do we need "and Coder satellite companies"?
There was a problem hiding this comment.
Addressed both of these, and updated the script, too
|
Addressed all the feedback. I don't want to update the source URLs now, since we haven't pushed the latest changes to the production Registry site, but I went ahead and made a separate PR to handle that. |
Changes made
Notes