This repository houses a microsite about 18F's portfolios. We use the U.S. Web Design System for the front end interface. The site is built and served through the Federalist platform.
To contribute, you'll just need a GitHub account. After that, check out CONTRIBUTING.MD for some more details.
For Public Benefits Portfolio content, check out 🔒 our governance/approval process. 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.
Projects are stored in the _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, which builds into this page on the site.
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 and pages that use that layout, starting from a "home" page. This can likely just be duplicated and edited, though a ready-to-use template is on the roadmap.
Run each of the following steps to get the site up and running:
git clone git@github.com:18F/portfolioscd portfoliosbundle installbundle exec jekyll serve
You should be able to see the site at: http://127.0.0.1:4000/
The site is a static website with HTML, CSS, and Javascript. Deployments are done through Federalist.
- Federalist runs in its own organization and space in cloud.gov, which piggybacks on AWS GovCloud.
- Federalist Admin: https://federalist.18f.gov/.
- Federalist responds to a webhook on GitHub and runs Jekyll to generate static web files and puts them in an S3 bucket.
- We map portfolios.18f.gov URL to the S3 bucket.