Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 2.83 KB

README.md

File metadata and controls

55 lines (34 loc) · 2.83 KB
Raw

18F's Homepage

This repository contains 18F's website, https://18f.gsa.gov.

  • The staging branch is automatically deployed to our staging site.
  • The production branch is automatically deployed to our production site.

All development and pull requests should be done against the staging branch.

Deployments to production will be done by site admins, using PRs from staging to production.

Adding yourself to the site

If you're a new teammate, add yourself to the website by:

  1. Either fork the repository, or make a new branch inside the repo if you have write permissions.
  2. Add your name to _data/team.yml. Your name should be an all-lower-case handle, and must be unique among the team. Your full_name should be how you want your name to be displayed beneath your picture, and on your blog post bylines.
  3. Add a 250x250 JPG of yourself to assets/images/team. The filename must be your unique team handle, e.g. eric.jpg.
  4. (Optional) Verify that your photo and name looks right by running the site locally.
  5. Submit a pull request from your fork or branch to this repository's staging branch.
  6. When your PR is merged, your face and name should appear automatically on our staging site.

A site admin will take care of deploying you to the live site. Feel free to poke them if they don't get around to it in a timely fashion!

Developing the site

This is a Jekyll website. Install Jekyll through Rubygems (you may need sudo):

gem install jekyll

Sadly, for the time being you will also need Node to be installed, because Jekyll 2 couples a CoffeeScript runtime. This will eventually be removed. Install Node through brew install node or apt-get install nodejs.

Launch with Jekyll:

jekyll serve

The site will be visible at http://localhost:4000.

Deploying the site

You don't need to worry about deployment stuff for normal development -- any pushes to staging and production branches will auto-deploy.

But to dig into our deployment setup and code, visit deploy/ for more details.

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.