add contributing details to README (18F#30)

* add contributing details to README * press save before committing * add very important space after emoji * move lock icon into link (a11y reasons) Signed-off-by: Robert Jolly <[email protected]> Co-authored-by: Robert Jolly <[email protected]>
amyashida · Mar 11, 2021 · af14a18 · af14a18
1 parent adf4900
commit af14a18
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -5,11 +5,19 @@
 
 This repository houses a microsite about 18F's portfolios. We use the [U.S. Web Design System](https://designsystem.digital.gov/) for the front end interface. The site is built and served through [the Federalist platform](https://federalist.18f.gov/).
 
-### Style and style guide
+## Contributing
 
-This site extends the [U.S. Web Design System](https://designsystem.digital.gov/) and [18F Brand guidelines](https://pages.18f.gov/brand/) to create a style that is professional, unique, and informative. The style guide, located at [18f.gsa.gov/styleguide/](https://18f.gsa.gov/styleguide/) documents the patterns and components used to create this theme.
+To contribute, you'll just need a GitHub account. After that, check out [CONTRIBUTING.MD](./CONTRIBUTING.MD) for some more details.
 
-[View style guide](https://18f.gsa.gov/styleguide/)
+For Human Services Portfolio content, check out [🔒 our governance/approval process](https://docs.google.com/document/d/18JpJs6HDY624atN8RcL1vgTCkLOfd2_T7C-2BFEMPQI/edit#heading=h.w7bz3n3oh45o). The is no Official Editor as of yet, but you can hop into either the #portfolio-site or #portfolio-human-srvcs channel on Slack, or tag/DM @stvnrlly.
+
+### Adding a portfolio project
+
+Projects are stored in the [_portfolio_projects](./_portfolio_projects) Jekyll collection. Currently, there are two general types:
+
+Single page overviews are...single page overviews. The body of the page is a narrative about the project, and YAML metadata is used to fill in the sidebar and for filling small bits of information around the site. For an example, see the [Air Force Material Command project](./_portfolio_projects/afmc.md), which builds into [this page on the site](https://portfolios.18f.gov/projects/afmc/).
+
+Project microsites are more customizable and allow projects to set up their own site structure. Currently, they're set up using a combination of a Jekyll layout and a few markdown files. For an example, the Eligibility APIs microsite is built from [a custom layout](./_layouts/hs-api-page.html) and pages that use that layout, [starting from a "home" page](./_portfolio_projects/hs-apis-home). This can likely just be duplicated and edited, though a ready-to-use template is on the roadmap.
 
 ## Installation and Deployment
 

diff --git a/_portfolios_projects/afmc.md b/_portfolios_projects/afmc.md
@@ -1,18 +1,18 @@
 ---
-agency: 412th Operations Group of the Air Force Material Command (AFMC) 
+agency: 412th Operations Group of the Air Force Material Command (AFMC)
 title: Modernizing legacy systems
-subtitle: 
+subtitle:
 permalink: /projects/afmc/
-redirect_from: 
+redirect_from:
 excerpt: The 412th Operations Group of the Air Force Material Command (AFMC) was looking for help to modernize their legacy Center Ops Online (COOL) system, which had been developed over the past 19 years and was ready for a holistic user-based refresh.  
 image: /assets/img/portfolios/project-cards/afcool.jpg
 image_accessibility: Photo of an Air Force airplane at the 412th operations group of the Air Force Material Command (AFMC) site.
 image_icon:
 project_weight: 3
-tag: 
+tag:
 expiration_date:
 github_repo:
-  - 
+  -
 project_url:
 learn_more:
 product_clients:
@@ -21,11 +21,11 @@ portfolio: National Security and Intelligence
 featured: true
 ---
 
-The 412th Operations Group of the Air Force Material Command (AFMC) was looking for help to modernize their legacy Center Ops Online (COOL) system, which had been developed over the past 19 years and was ready for a holistic user-based refresh. AFMC was specifically seeking to upgrade COOL to provide a web-based platform that would ensure current, qualified, available air crew were able to be scheduled for and execute test missions. 
+The 412th Operations Group of the Air Force Material Command (AFMC) was looking for help to modernize their legacy Center Ops Online (COOL) system, which had been developed over the past 19 years and was ready for a holistic user-based refresh. AFMC was specifically seeking to upgrade COOL to provide a web-based platform that would ensure current, qualified, available air crew were able to be scheduled for and execute test missions.
 
 ## What did we do
 
-The AFMC selected to work with 18F on the COOL 2.0 project as a multi-phase engagement consisting of both a Path Analysis (research phase) and an Experiment and Iterate (E&I) phase. During the Path Analysis a series of stakeholder and end user interviews were conducted, workflow mapping, process assessment, and a high level UX audit was performed to identify the main problems in modernizing the COOL system. 
+The AFMC selected to work with 18F on the COOL 2.0 project as a multi-phase engagement consisting of both a Path Analysis (research phase) and an Experiment and Iterate (E&I) phase. During the Path Analysis a series of stakeholder and end user interviews were conducted, workflow mapping, process assessment, and a high level UX audit was performed to identify the main problems in modernizing the COOL system.
 
 ## What were the findings or recommendations