You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: MAINTAINER.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,6 +64,7 @@ The validation exists for two reasons:
64
64
In addition to the general criteria, all namespace README files must have:
65
65
66
66
- Frontmatter metadata with support for the following fields:
67
+
67
68
-`display_name` (required string) – The name to use when displaying the user profile in the Coder Registry site
68
69
-`bio` (optional string) – A short description of who they are
69
70
-`github` (optional string) – Their GitHub handle
@@ -79,6 +80,7 @@ In addition to the general criteria, all namespace README files must have:
79
80
In addition to the general criteria, all module README files must have:
80
81
81
82
- Frontmatter that describes metadata for the module:
83
+
82
84
-`display_name` (required string) – This is the name displayed on the Coder Registry website
83
85
-`description` (required string) – A short description of the module, which is displayed on the Registry website
84
86
-`icon` (required string) – A relative/absolute URL pointing to the icon to display for the module in the Coder Registry website
@@ -88,6 +90,7 @@ In addition to the general criteria, all module README files must have:
88
90
-`partner_github` (deprecated string) - The name of any additional creators for a module. This field exists for backwards compatibility with previous versions of the Registry, but should not ever be used going forward
89
91
90
92
- The following content directly under the h1 header (without another header between them):
93
+
91
94
- A description of what the module does
92
95
- A Terraform snippet for letting other users import the functionality
@@ -289,4 +293,4 @@ For maintainer-specific questions or issues:
289
293
- Repository issues for public discussion
290
294
- Security email for sensitive issues
291
295
292
-
Remember: As a maintainer, you're responsible for maintaining the quality and security of the Registry. When in doubt, err on the side of caution and seek additional review.
296
+
Remember: As a maintainer, you're responsible for maintaining the quality and security of the Registry. When in doubt, err on the side of caution and seek additional review.
0 commit comments