U.S. Department of the Treasury myRA Program

Move to closed-source

On 10/15/2015, the Treasury Bureau of the Fiscal Service confirmed to 18F they were closing the source for the myRA program. This repo only reflects the system as it existed before it was delivered to Treasury and they took over all hosting duties. It does not reflect what is currently on https://myra.gov/.

What

Individual and employer landing pages for the U.S. Department of the Treasury’s new retirement savings program, myRA (“My Retirement Account”).

We plan to use this repository as a place to share our work and direction, but please do not consider anything you see here to be final or production-ready. This is still very much in beta.

Why

This effort is in support of Treasury's new myRA program, which is currently being developed to provide a simple, safe, and affordable way for individuals to start saving.

How it works

The myRA landing pages are static HTML/CSS/JS pages. We maintain the pages in simple Markdown files, which are compiled into HTML by Jekyll. We also use Sass as a preprocessor for the CSS.

Getting started

Ruby gems:

• gem install jekyll

This site is deployed using Jekyll 2.4.

To keep our code updating continuously as we edit, we use jekyll serve --baseurl '' --watch.

The Branches

• master This is the branch that lives online at https://myra.treasury.gov
• staging This is the branch to work on rigth before deploying to master
• gh-pages This is the branch to use for demoing new features on https://18f.github.io/myra

File Structure

_data/
|-- navigation.yml    Data file that controls the site-wide header menu

_includes/            Partials to be included on various pages

_layouts/             Two templates for all pages
|-- splash.html       Template to use for home, /individuals and /employers
|-- default.html      Template for all other pages

_site/                The directory that Jekyll compiles everything into

_about/               Pages for the About section

_employers/           Pages for the Employers section

_individuals/         Pages for the Individuals section

_resources/           All resource files for both individuals and employers

_static/              Sass, JS, images and compiled css

Contributing

Content and feature suggestions are welcome via GitHub Issues. Code contributions are welcome via pull request, although of course we cannot guarantee your changes will be included.

Deploying the site

To deploy the site to production, at https://myra.treasury.gov, you will need:

• Access to the 18F Amazon Web Services account.
• Permissions to upload to a particular S3 bucket, myra-cloudfront.
• A command line client to perform the upload, such as s3cmd or the official aws tool. Instructions below show s3cmd. Install s3cmd on Mac with brew install s3cmd, and Ubuntu with apt-get install s3cmd.

To deploy:

• From the project root, build the site using the production configuration:

jekyll build --config _config.yml,_config-production.yml

• If the site built without errors, upload the website to the S3 bucket. The below command uses s3cmd to upload all files in _site, make them public, and tells both browsers and CloudFront to cache files for an hour.

From the project root:

s3cmd  put --recursive --add-header="Cache-Control:max-age=3600" -P _site/* s3://myra-cloudfront/

You can see the results of your work immediately at http://myra-cloudfront.s3-website-us-east-1.amazonaws.com.

The live site, https://myra.treasury.gov, will take up to an hour to update.

Bear in mind that the delay time to update the live site depends on the previous deploy's specified cache time, not the one you just did. Assuming you always use the same cache time, it will always update within an hour.

If you need an immediate update, you will have to "invalidate" the CloudFront distribution, using either the web console or a third party tool. (Neither the aws nor s3cmd tools properly support this yet.)

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.