Merge pull request #2 from Human-Augment-Analytics/setup

Update status options and add null guidance

Author: riyamzaman

README.md

@@ -1,31 +1,33 @@
 # HAAG Project Explorer
-Metadata for HAAG research projects to display on the HAAG website.
+The goal of this project explorer is to provide visibility into the projects under HAAG. This repository holds the metadata for HAAG research projects that will be displayed on the HAAG website.
 
 ## Template
+This is the template to be used to structure the metadata. For fields (such as links) that you want to leave blank, please populate with `null`.
+
 ```yaml
 id: project-id
 name: Project Title
-status: active      # Research status. active | completed | pending | archived
+status: active      # Research status. active | completed | preprint | archived
 visibility: private # For code visibility. public (for open-source projects) | private (if not to be publicly visible at this time)
 faculty: # PI / Faculty
   - 
 researchers: # List research contributors here
   - 
   -
-advisors: # List computational advisors if any exist on the project
+advisors: # List computational advisors if any exist on the project (if none exist, mark as null).
   - 
   - 
 summary: > # Summarize the project
   Summary here.
-tags: # Optional for now, but will be used to categorize the projects into groupings (such as unit groups)
+tags: # Optional for now, but will be used to categorize the projects into groupings (such as unit groups). If unknown, mark with null.
   - 
   -
 links:
-  github: https://github.com/... # placeholder, if public
-  docs: https://example.com/docs # Could be README, wiki, github pages, project website, etc.
+  github: https://github.com/...   # placeholder, if public
+  docs: https://example.com/docs   # Could be README, wiki, github pages, project website, etc.
   publication: https://doi.org/... # If exists/preprint/completed
-  forum: https://example.com/forum # link to forum - @James Hennessy - await guidance on this
-  contact: mailto:lab@example.edu # Contact to reach out to for interested parties (lab-level email distribution), or leave blank at this time if there isn't an email distribution that is setup at this time
+  forum: https://example.com/forum # link to forum - @James Hennessy - leave null for now
+  contact: mailto:lab@example.edu  # Contact to reach out to for interested parties (lab-level email distribution), or leave null at this time if there isn't an email distribution that is setup at this time
 ```
 
 ## Example

projects/3d-color-modeling.yml

@@ -1,6 +1,6 @@
 id: 3d-color-modeling
 name: 3D Color Modeling
-status: active      # active | completed | pending | archived
+status: active      # active | completed | preprint | archived
 visibility: private # public | private
 faculty:
   - Arthur Porto

projects/3d-fossils.yml

@@ -1,6 +1,6 @@
 id: 3d-fossils
 name: 3D Fossils
-status: active      # active | completed | pending | archived
+status: active      # active | completed | preprint | archived
 visibility: private # public | private
 faculty:
   - Arthur Porto

projects/3d-generative-models.yml

@@ -1,6 +1,6 @@
 id: 3d-generative-models
 name: 3D Generative Models
-status: active      # active | completed | pending | archived
+status: active      # active | completed | preprint | archived
 visibility: private # public | private
 faculty:
   - Supratik Mukhopadhyay

projects/ai-for-mental-health.yml

@@ -1,6 +1,6 @@
 id: ai-for-mental-health
 name: AI for Mental Health
-status: active      # active | completed | pending | archived
+status: active      # active | completed | preprint | archived
 visibility: private # public | private
 faculty:
   - Anind Dey

projects/animal-detection-spatial.yml

@@ -1,6 +1,6 @@
 id: animal-detection-spatial
 name: Animal Detection - Spatial Camera Trap
-status: active      # active | completed | pending | archived
+status: active      # active | completed | preprint | archived
 visibility: private # public | private
 faculty:
   - Jenny McGuire

projects/animal-detection.yml

@@ -1,6 +1,6 @@
 id: animal-detection
 name: Animal Detection - Stone Mountain
-status: active      # active | completed | pending | archived
+status: active      # active | completed | preprint | archived
 visibility: private # public | private
 faculty:
   - Jenny McGuire

projects/bird-audio.yml

@@ -1,6 +1,6 @@
 id: bird-audio
 name: Bird Audio
-status: active      # active | completed | pending | archived
+status: active      # active | completed | preprint | archived
 visibility: private # public | private
 faculty:
   - Benjamin Freeman

projects/bird-behavior.yml

@@ -1,6 +1,6 @@
 id: bird-behavior
 name: Bird Behavior
-status: active      # active | completed | pending | archived
+status: active      # active | completed | preprint | archived
 visibility: private # public | private
 faculty:
   - Benjamin Freeman

projects/charleston-train.yml

@@ -1,6 +1,6 @@
 id: charleston-train
 name: Charleston Train
-status: active      # active | completed | pending | archived
+status: active      # active | completed | preprint | archived
 visibility: private # public | private
 faculty:
   - Steve Mussmann