content: add OSSI project status field

JaneliaSciComp · May 24, 2024 · 72f4351 · 72f4351
1 parent 9ffdc6b
commit 72f4351
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -172,12 +172,13 @@ At the top of your project file are data sandwiched between triple-dashes (---).
 | `title`                          | Required                                                                                                  | Your project title.                                                                                                                                                                                                                                                                                                          |
 | `tagline`                        | Required                                                                                                  | One or two sentences describing your project.                                                                                                                                                                                                                                                                                |
 | `maintainer`                     | Required                                                                                                  | The maintainer of the project page on this website. This should be the name of one primary point-of-contact.                                                                                                                                                                                                                 |
-| `maintainer contact info`        | Required                                                                                                  | The preferred contact method for the maintainer - this should either an email address in the format of mailto:[email protected] or a link to a contact method the maintainer actively uses. E.g., a link to the issues page for the GitHub repo, or to the maintainer/project's X, Instagram, LinkedIn, or Facebook profile. |
 | `project type`                   | Required                                                                                                  | Pick **one** of the three options provided in the template based on whether your software project is currently or was ever supported by OSSI: `[OSSI - current, OSSI - previous, Other]`. Delete the other two options, leaving the square brackets around your choice.                                                      |
+| `OSSI project status`             | Required for current and previous OSSI-funded projects                                                    | Pick one option: `[Proposed, Accepted, Active Development, Maintenance]`. Leave the square brackets around your choice.                                                                                                                           |
 | `OSSI proposal link`             | Required for current and previous OSSI-funded projects                                                    | Preferred: upload the proposal as a PDF to `public/proposals` and provide the link in the format `./../proposals/PROPOSAL.pdf`. Other option: provide the URL to the externally hosted proposal.                                                                                                                             |
 | `github link`                    | Required                                                                                                  | Link to the software project's GitHub repository.                                                                                                                                                                                                                                                                            |
 | `documentation link`             | Required                                                                                                  | Link to software documentation - can be the same as the GitHub repo if the README is the documentation                                                                                                                                                                                                                       |
 | `installation instructions link` | Required                                                                                                  | Link to software installation instructions - can be the same as the GitHub repo                                                                                                                                                                                                                                              |
+| `preferred contact method`        | 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]. Used to create the link for the 'Reach out for help' button on the project page.  |
 | `how to cite text`               | Required if your software has an associated published paper or DOI                                        | The citation for your software - wrap in quotes to ensure colons are interpreted correctly. If your software doesn't have an associated published paper or DOI, leave this blank.                                                                                                                                            |
 | `how to cite link`               | Optional. </br> _Reminder - comment out or delete optional fields you do not wish to provide a value for_ | A DOI. Wrap in quotes to ensure the colon is interpreted correctly. If a DOI is not available, leave this blank - your GitHub repo will be used as the default. Each DOI should start with `https://doi.org/`                                                                                                                |
 | `additional links array`         | Optional                                                                                                  | Optional external links formatted in a comma-separated array. If there is a colon in a link, wrap the entire link in quotations. For example, you could provide links to a project homepage, an externally-hosted blog post, additional publications, etc.                                                                   |

diff --git a/src/content/config.ts b/src/content/config.ts
@@ -8,6 +8,7 @@ const projectsCollection = defineCollection({
     tagline: z.string(),
     maintainer: z.string(),
     "project type": z.array(z.string()),
+    "OSSI project status": z.array(z.string()).optional(),
     "OSSI proposal link": z.string().optional(),
     "github link": z.string(),
     "documentation link": z.string(),

diff --git a/src/content/projects/_project-template.md b/src/content/projects/_project-template.md
@@ -4,6 +4,8 @@ tagline: "Required. 1-2 sentences that describe your project. An aside: if you u
 maintainer: Required. Name of the person responsible for maintaining this project page. For internal use/reference - not posted to the website.
 #project type - Required. Pick one of the three options - delete the other two.
 project type: [OSSI - current, OSSI - alumni, Other]
+#OSSI project status - Required if your project is OSSI-funded. Pick one option.
+OSSI project status: [Proposed, Accepted, Active Development, Maintenance]
 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