forked from 18F/18f.gsa.gov
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fully redesigns the site, see commit history at 18F/beta.18f.gov
As soon as this becomes the main branch both here and in Federalist, we're good.
- Loading branch information
Greg Boone
committed
Aug 31, 2016
1 parent
c7a02f3
commit 3e19ee7
Showing
2,221 changed files
with
36,728 additions
and
10,477 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,77 +1,35 @@ | ||
## 18F's Homepage | ||
# 18F's flagship website | ||
|
||
This repository contains 18F's website, https://18f.gsa.gov. | ||
A fresh start for 18f.gsa.gov. Online at beta.18f.gov. We plan to use the U.S. Web Design standards as a frontend framework. | ||
|
||
**Writing a blog post for 18F? You must read our [blog publishing guide](_posts/README.md).** | ||
## Installation | ||
|
||
### Deployment and workflow | ||
Run each of the following steps to get the site up and running. | ||
|
||
* The `staging` branch is **automatically deployed** to our [staging site](https://staging.18f.gov). | ||
* The `production` branch is **automatically deployed** to our [production site](https://18f.gsa.gov). | ||
1. `git clone [email protected]:18F/beta.18f.gov` | ||
2. `cd beta.18f.gov` | ||
3. `bundle install` | ||
4. `jekyll serve` | ||
|
||
**All development and pull requests should be done against the `staging` branch.** | ||
To dramatically speed up rebuild times (from more than 20 seconds to around 5), you can also run `./serve` or `./build` for step 4. These are shorthand for a combination of commands that disable certain plugins. This is especially useful if you're drafting a blog post or formatting single pages. | ||
|
||
Deployments to production will be done by site admins, using pull requests from `staging` to `production`. | ||
You should be able to see the site at: http://127.0.0.1:4000 | ||
|
||
We occasionally use various subdomains of 18f.gov to demo work in a way that others can see it. These deployments are manual and require a little bit of extra configuration. See the readme file in the "deploy" folder for more information on how this works. | ||
## System security controls | ||
|
||
### Getting your picture and bio on the site: | ||
The site is a static website with HTML, CSS, and Javascript. Deployments are done through the Federalist platform. | ||
|
||
If you're a new teammate, follow these steps and the #18f-site team will take care of it: | ||
1. Federalist runs in its own organization and space in CloudFoundry | ||
1. Federalist Admin: https://federalist.18f.gov/ | ||
1. Using the Federalist editor that requires GitHub Oauth and writes commits as auth'd GitHub user, changes are then passed through a webhook back to Federalist | ||
1. Federalist uses a CloudFoundry S3 service to write to the bucket, the Federalist instance only derives S3 credentials (IAM user: s3-sb-federalist.18f.gov) from the CloudFoundry S3 service and can only read/write to federalist.18f.gov/* | ||
1. Federalist responds to a webhook on GitHub and runs Jekyll to generate static web files and puts them in an S3 bucket | ||
1. We map whatever.agency.gov URL to the S3 bucket | ||
|
||
1. Upload your photo to the appropriate [Google Drive folder](https://drive.google.com/a/gsa.gov/folderview?id=0B8kn3cuJUwEkLUMwWXE2VVczbUU&usp=sharing). | ||
2. Fill out the [bio form](https://docs.google.com/a/gsa.gov/forms/d/1XRCkQZw3-1JoZh6tm4k1qbunEnvJdOvDrTjRCqs-dp4/viewform). | ||
3. Get in touch with the site team in #18f-site; we'll handle it from there! | ||
### Constraints | ||
|
||
NOTE: Bios and pictures are scheduled to be added at the end of each month. | ||
|
||
**You do not need to edit the team.json or authors.yml files in this repo,** we'll find it in `team-api.18f.gov`. | ||
|
||
If you get stuck, or have any other questions, feel free to reach out to anyone on the 18f-site team in channel #18f-site. | ||
|
||
Helpful tips: | ||
|
||
* [Our Guide to the Terminal and GitHub](https://18f.gsa.gov/2015/03/03/how-to-use-github-and-the-terminal-a-guide/) | ||
* [Creating a Pull Request (GitHub Support)](https://help.github.com/articles/creating-a-pull-request/) | ||
* [Creating a Pull Request with GitHub for Mac (GitHub blog post)](https://github.com/blog/1946-create-pull-requests-with-github-for-mac) | ||
|
||
|
||
### Publishing a blog post | ||
|
||
For a guide to how 18F manages blogging, and technical guidelines for getting your blog post into the site, see the **[18F Blogging Guide](_posts/README.md)**. | ||
|
||
### Developing the site | ||
|
||
This is a [Jekyll](http://jekyllrb.com) website. Install Jekyll through Rubygems (you may need `sudo`), Bourbon, and Jekyll Sitemap: | ||
|
||
```bash | ||
./go init | ||
``` | ||
|
||
Prerequisites: A few of our gems require a C++ compiler (**XCode** on the Mac). [For the time being](https://github.com/jekyll/jekyll/issues/2327#issuecomment-55337023) you will also need **Node** to be installed, because Jekyll 2 couples a CoffeeScript runtime. This will eventually be removed. | ||
|
||
So yes: this project requires Ruby and Node (for now). Aren't static site generators the simplest? | ||
|
||
Launch with Jekyll: | ||
|
||
```bash | ||
./go serve | ||
``` | ||
|
||
The site will be visible at `http://localhost:4000`. | ||
|
||
Before submitting a pull request, please ensure `./go ci_build` runs and exits cleanly. | ||
|
||
### 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/`](deploy) for more details. | ||
|
||
### Public domain | ||
|
||
This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md): | ||
|
||
> 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](https://creativecommons.org/publicdomain/zero/1.0/). | ||
> | ||
> 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. | ||
* We'll use Cloudfront to map beta.18f.gov to an S3 endpoint | ||
* IE 9 and above | ||
* Federalist, and the CloudFoundry platform do not support the following HTTPS implementations: | ||
* HTTP/2 | ||
* OSCP Stapling |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.