Skip to content

Commit

Permalink
chore: clarify purpose of preferred contact method field
Browse files Browse the repository at this point in the history
  • Loading branch information
allison-truhlar committed May 22, 2024
1 parent 3ab0bde commit 77f9176
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ try {
class="self-start btn rounded-md p-2 font-normal"
href={frontmatter["preferred contact method"]}
>
Ask a question
Reach out with a question
</a>
)
}
Expand Down
2 changes: 1 addition & 1 deletion src/content/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ const projectsCollection = defineCollection({
title: z.string(),
tagline: z.string(),
maintainer: z.string(),
"preferred contact method": z.string().optional(),
"project type": z.array(z.string()),
"OSSI proposal link": z.string().optional(),
"github link": z.string(),
"documentation link": z.string(),
"installation instructions link": z.string().optional(),
"how to cite text": z.union([z.string(), z.undefined(), z.null()]),
"how to cite link": z.union([z.string(), z.undefined(), z.null()]),
"preferred contact method": z.string().optional(),
"additional links array": z.array(z.string()).optional(),
"additional links text array": z.array(z.string()).optional(),
"related blog posts": z.union([
Expand Down
2 changes: 1 addition & 1 deletion src/content/projects/_project-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
title: Required. Your project title.
tagline: "Required. 1-2 sentences that describe your project. An aside: if you use a colon in a field value, you must wrap the entire phrase in quotes. Otherwise, quotes are not required."
maintainer: Required. Name of the person responsible for maintaining this project page. For internal use/reference - not posted to the website.
preferred contact method: "Required if the preferred way for users to reach out for help is something other than creating an issue in the project's GitHub repo. Examples: link to Image.sc forum, or email in the format of mailto:[email protected]"
#project type - Required. Pick one of the three options - delete the other two.
project type: [OSSI - current, OSSI - alumni, Other]
OSSI proposal link: Required if your project is OSSI-funded. Preferred - upload the proposal as a PDF to `public/proposals` and provide the link in the format `../../proposals/PROPOSAL.pdf`. Other option - URL to the externally hosted proposal.
github link: Required. Link to GitHub repository
documentation link: Required. Link to documentation - can be the same as the GitHub repo if the README is the documentation
installation instructions link: Required. Link to installation instructions - can be the same as the GitHub repo
preferred contact method: "Creates the link for the 'Reach out for help' button on the project page. Encouraged if there is a preferred way for users to reach out for help other than creating an issue in the project's GitHub repo. Examples: link to Image.sc forum, or an email in the format of mailto:[email protected]."
how to cite text: "If your software doesn't have an associated published paper or DOI, delete or comment-out this field to use your GitHub repo as the default. Otherwise, provide the citation for your software - wrap in quotes to ensure colons are interpreted correctly. "
how to cite link: "https://doi.org/example - wrap entire link in quotes. If a DOI is not available, then delete or comment-out this field to use your GitHub repo as the default."
additional links array:
Expand Down

0 comments on commit 77f9176

Please sign in to comment.