Skip to content

Commit

Permalink
Merge remote-tracking branch 'usds/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
GP authored and GP committed Jan 20, 2017
2 parents a948986 + 186a7c1 commit 384c616
Show file tree
Hide file tree
Showing 4 changed files with 166 additions and 45 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Welcome!

We're so glad you're thinking about contributing to a USDS open source
repository! If you're unsure or afraid of anything, just ask or submit the
issue or pull request anyways. The worst that can happen is that you'll be
politely asked to change something. We appreciate any sort of contribution,
and don't want a wall of rules to get in the way of that.

Before contributing, we encourage you to read our CONTRIBUTING policy (you are
here), our LICENSE, and our README, all of which should be in this repository.

## Public domain

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.
59 changes: 59 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
This project includes a mix of the following:

* Open source works that are not in the public domain
* Open source work by the U.S. government that is in the public domain

## Parts of this project that are not in the public domain

This site is based on the Draft U.S. Web Design Standards (WDS), which also
includes works under the SIL Open Font License, MIT license, and public
domain. Files from the WDS are in `_sass/_libs/wds/`, and the full license
details for those assets are described in the [WDS license
file](https://github.com/18F/web-design-standards/blob/staging/LICENSE.md).

This site also includes a number of images that have various copyright
statuses, including Creative Commons licenses and public domain. These images
are in the `assets` directory, and license details are available on the posts
and pages that display the images.

## The rest of this project is in the worldwide public domain

As a work of the United States government, this project is in the public
domain within the United States.

Additionally, we waive copyright and related rights in the work worldwide
through the [CC0 1.0 Universal public domain
dedication](https://creativecommons.org/publicdomain/zero/1.0/).

### CC0 1.0 Universal Summary

This is a human-readable summary of the [Legal Code (read the full
text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).

#### No copyright

The person who associated a work with this deed has dedicated the work to the
public domain by waiving all of his or her rights to the work worldwide under
copyright law, including all related and neighboring rights, to the extent
allowed by law.

You can copy, modify, distribute and perform the work, even for commercial
purposes, all without asking permission.

#### Other information

In no way are the patent or trademark rights of any person affected by CC0,
nor are the rights that other persons may have in the work or in how the work
is used, such as publicity or privacy rights.

Unless expressly stated otherwise, the person who associated a work with this
deed makes no warranties about the work, and disclaims liability for all uses
of the work, to the fullest extent permitted by applicable law. When using or
citing the work, you should not imply endorsement by the author or the
affirmer.

### Contributions to this project

As stated in [CONTRIBUTING](CONTRIBUTING.md), 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.
61 changes: 16 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,29 @@
US Digital Service Website
==========================

This repo is for our public-facing site, which is hosted on usds.gov. This site is the main funnel for USDS recruiting and outreach.
This repo is for our public-facing site, which is hosted on
[https://usds.gov](https://usds.gov). This site is the main funnel for USDS
recruiting and outreach.

Soon, this repo will also contain our assets on [whitehouse.gov](https://www.whitehouse.gov/digital/united-states-digital-service).

The site is built on the [U.S. Web Design Standards](https://playbook.cio.gov/designstandards/) and uses Jekyll to generate static pages.
The site is built on the [U.S. Web Design
Standards](https://playbook.cio.gov/designstandards/) and uses Jekyll to
generate static pages.

Setup
---
1. If you're using a Mac, install homebrew (see http://brew.sh/)
2. After installing git (`brew install git`), `cd` to the directory where you want to check-out the site, and then clone it (`git clone https://github.com/usds/website.git`)
3. Install rvm (`\curl -sSL https://get.rvm.io | sudo bash -s stable`), make your current user a member of the rvm group, and then install a new version of ruby (`rvm install 2.3.1`)
4. Install the `bundler` gem, then use bundler to install other project dependencies (`gem install bundler && bundle install`)
2. After installing git (`brew install git`), `cd` to the directory where you
want to check-out the site, and then clone it (`git clone
https://github.com/usds/website.git`)
3. Install rvm (`\curl -sSL https://get.rvm.io | sudo bash -s stable`), make
your current user a member of the rvm group, and then install a new version
of ruby (`rvm install 2.3.1`)
4. Install the `bundler` gem, then use bundler to install other project
dependencies (`gem install bundler && bundle install`)

Running
---
1. In the directory you checked out the website into, run `jekyll serve` to start the webserver
1. In the directory you checked out the website into, run `jekyll serve` to
start the webserver
2. Navigate to http://localhost:4000 in your browser to see your changes

Blogging
---
The U.S. Digital Service blog is currently maintained on Medium. This website provides summaries of the most recent posts. When we publish a new post, we must also create a new blog summary. The `Blog` summary page is automatically generated from individual blog summary Markdown files in the `_blog_summaries` folder.

To create a new blog summary:
----

Create a new file in the `_blog_summaries` folder. Follow the file naming convention of starting the file name with the date of the blog post in the `YYYY-MM-DD` format, followed by a short description of the post, separated by an underscore. For example, to create a summary of a post about penguins published on April 1, 2016, you would create a file named `2016-04-01_penguins.md`.

Each blog post summary file must start with front-matter, in the YML format. This sets some variables that are used to build the blog summary page. After the front-matter, the remaining content in the markdown file will be used to generate the post summary. This content can be supplied in markdown format. Raw HTML can also be used.

An example post file is shown below:

```markdown
---
title: Meet the Team - March 2016
medium_url: https://medium.com/@USDigitalService/meet-the-team-ce394749a771
image_url: https://d262ilb51hltx0.cloudfront.net/max/600/1*UHwRMidm_-BHCOfycUvtPA.jpeg
image_description: Natalie Kates
date: 2016-03-23
---

Another week, another set of new smiling faces here at the U.S. Digital Service. This edition of “Meet the Team” adds a new twist. Fresh recruits shared their answers to a few question from the famous [Proust Questionnaire](https://en.wikipedia.org/wiki/Proust_Questionnaire). We know, we’re really earning that “Peace Corps for nerds” nickname.

```

A few notes on the above fields:

- `title`: The clickable headline of the blog post. Ordinarily, this should match the title of the post itself.
- `medium_url`: The full link, including `https://` to the full post.
- `image_url`: A link to an image representing the post. You should choose an image that is wider than it is tall (i.e. 16:9 aspect ratio). If there is an image in the Medium post, we can link to it on Medium directly. Note that Medium's image link allows us to specify the size of the image, in the `max/xxx` part of the URL. Ordinarily, we should set this to `600`, as shown in the above example.
- `image_description`: A short textual description of the image.
- `date`: The date the post was published, in `YYYY-MM-DD` format. This field is used to determine which post summaries are shown on the blog summary page.

Below the front matter (i.e. after the `---`) is the text that will appear as the summary of the blog. Ordinarily, this can be directly copied from the lede in our Medium post. Generally, this should be one single paragraph, without formatting. It can include links where appropriate. Links can be specified using the Markdown linking format, or by writing `<a>` tags directly.

Once a file matching this specification is saved into the `_blog_summaries` folder, the `/blog` page will be automatically re-generated to display the most recent summaries, with the most recent post appearing first. If this change is merged to the `gh-pages` branch of the site, the blog page will be updated.
70 changes: 70 additions & 0 deletions _blog_summaries/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
Blogging
---
The [U.S. Digital Service blog](https://medium.com/the-u-s-digital-service) is
currently maintained on Medium. This website provides summaries of the most
recent posts. When we publish a new post, we must also create a new blog
summary. The `Blog` summary page is automatically generated from individual
blog summary Markdown files in the `_blog_summaries` folder.

To create a new blog summary:
----

Create a new file in the `_blog_summaries` folder. Follow the file naming
convention of starting the file name with the date of the blog post in the
`YYYY-MM-DD` format, followed by a short description of the post, separated by
an underscore. For example, to create a summary of a post about penguins
published on April 1, 2016, you would create a file named
`2016-04-01_penguins.md`.

Each blog post summary file must start with front-matter, in the YML format.
This sets some variables that are used to build the blog summary page. After
the front-matter, the remaining content in the markdown file will be used to
generate the post summary. This content can be supplied in markdown format.
Raw HTML can also be used.

An example post file is shown below:

```markdown
---
title: Meet the Team - March 2016
medium_url: https://medium.com/@USDigitalService/meet-the-team-ce394749a771
image_url: https://d262ilb51hltx0.cloudfront.net/max/600/1*UHwRMidm_-BHCOfycUvtPA.jpeg
image_description: Natalie Kates
date: 2016-03-23
---

Another week, another set of new smiling faces here at the U.S. Digital
Service. This edition of “Meet the Team” adds a new twist. Fresh recruits
shared their answers to a few question from the famous [Proust
Questionnaire](https://en.wikipedia.org/wiki/Proust_Questionnaire). We know,
we’re really earning that “Peace Corps for nerds” nickname.

```

A few notes on the above fields:

- `title`: The clickable headline of the blog post. Ordinarily, this should
match the title of the post itself.
- `medium_url`: The full link, including `https://` to the full post.
- `image_url`: A link to an image representing the post. You should choose an
image that is wider than it is tall (i.e. 16:9 aspect ratio). If there is an
image in the Medium post, we can link to it on Medium directly. Note that
Medium's image link allows us to specify the size of the image, in the
`max/xxx` part of the URL. Ordinarily, we should set this to `600`, as shown
in the above example.
- `image_description`: A short textual description of the image.
- `date`: The date the post was published, in `YYYY-MM-DD` format. This field
is used to determine which post summaries are shown on the blog summary
page.

Below the front matter (i.e. after the `---`) is the text that will appear as
the summary of the blog. Ordinarily, this can be directly copied from the lede
in our Medium post. Generally, this should be one single paragraph, without
formatting. It can include links where appropriate. Links can be specified
using the Markdown linking format, or by writing `<a>` tags directly.

Once a file matching this specification is saved into the `_blog_summaries`
folder, the `/blog` page will be automatically re-generated to display the
most recent summaries, with the most recent post appearing first. If this
change is merged to the `gh-pages` branch of the site, the blog page will be
updated.

0 comments on commit 384c616

Please sign in to comment.