18f / federalist-modern-team-template

This is a Jekyll site. It is a simple site to showcase the work of an organization with a few different page types.

Modern Team Template for Federalist

development moved to https://github.com/18F/federalist-uswds-jekyll

This is a Jekyll site. It is a simple site to showcase the work of an organization with a few different page types.

This particular site is made for use with the Federalist in mind.

This template uses the CSS and JavaScript from U.S. Web Design System. To update the version of the system, download the code from the website. Unzip the download and drop the entire folder (which should be named something like uswds-1.1.0) into assets/vendor.

In your _config.yml, update the wds-version value to the new version number. This should match the version number in the name of the folder you just downloaded. In the case of our example, it would look like this: wds-version: 1.1.0. You'll need to restart your Jekyll server to see the new code take effect.

18F Open Source Policy

This repository contains the official Open Source Policy of 18F (a digital delivery team within the General Services Administration).

Read 18F's Open Source Policy.

18F Team Guidance

For 18F team members, we have guidance on how 18F puts this policy into practice, and how we handle the narrow situations where we may delay or withhold the release of source code.

18F's open source team practices.

Credits

This policy was originally forked from the Consumer Financial Protection Bureau's policy. Thanks also to @benbalter for his insights regarding CFPB's initial policy.

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.

federalist-modern-team-template's Issues

Hover states missing on nav links

The top and bottom navigation links have a slight hover state before visiting, and no hover state after visiting. Both could use more contrast / different treatment.

Add an "edit this page" button

add an "edit this page" button to the base template that links to the current page markdown file in edit mode.

Margins on the video are two big for small viewports

Navigation Configuration is in several locations

• https://github.com/18F/federalist-modern-team-template/blob/master/_data/navbar.yml
• https://github.com/18F/federalist-modern-team-template/blob/master/_layouts/sidenav-page.html
• https://github.com/18F/federalist-modern-team-template/blob/master/_config.yml
• https://github.com/18F/federalist-modern-team-template/blob/master/_navigation.json

All of these links appear to have menu configuration; their management is unclear and not very usable.

Navbar configuration is formatted awkwardly

https://github.com/18F/federalist-modern-team-template/blob/master/_data/navbar.yml uses href oddly.

Consider less wide hero text

Seems like the hero text could be less wide to cover less of the background image, and the text could wrap an additional line:

Featured Projects Display is awkward

The data structure of the site should be more clear.

Footer Configuration is hard to find

the _config.yml file currently has the information for the footer, but its unclear how to find that. We should consider having a separate file with this config.

Center US site notice

The notice on the top seems better centered:

Make "edit this page" button more visible

change font or paragraph, anything to make the link easier to see and click

Template includes SBST PDF files that may not be needed

Over in the cg-landing repository, we have a directory of SBST PDF files left over from when we presumably copied this template, which we hadn't noticed until now. :) This isn't really a problem for us (we'll just delete them from that repo), but it made me realize the PDF files directory in this template might be good to delete from here too, if they aren't helpful to the template.

how do we handle raw vs www url?

looks like head.html has 1 javascript in it
- to replace www. with an empty string
- this seems opposite of the historical default for our site

Update header to be clearer on how SSL works

Have clear instructions on the template for implementing GA

Menu behavior not as expected

• Children don't seem to "drop down"
• Menu Items don't work if they're links offsite… actually setting permalink does but 'nav.href' seems to be unused?
• No way to add external links