Skip to content
This repository has been archived by the owner on Feb 15, 2020. It is now read-only.

Commit

Permalink
Merge branch 'master' into link-to-contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
hbillings committed Aug 15, 2018
2 parents 6bab4dd + ffe15ce commit ed5ea1a
Show file tree
Hide file tree
Showing 33 changed files with 209 additions and 189 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
@@ -1,5 +1,5 @@
## Building the guide locally
The front end guide is built on the [USWDS Jekyll theme gem](https://github.com/18F/uswds-jekyll).
The Front-End Guide is built on the [USWDS Jekyll theme gem](https://github.com/18F/uswds-jekyll).

To run it locally, clone this repo and then:
1. Install [http://bundler.io/](Bundler) if you don't already have it: `gem install bundler`
Expand Down
77 changes: 42 additions & 35 deletions Gemfile.lock
@@ -1,84 +1,91 @@
GIT
remote: https://github.com/18F/uswds-jekyll.git
revision: 1eacf596c2a631c57e82697139474d21cf459553
revision: 374e5c14940a71578d21d65186c05f507446a1c5
specs:
uswds-jekyll (1.2.0)
uswds-jekyll (3.0.0)
jekyll (~> 3.4)

GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.7.1)
activesupport (4.2.10)
i18n (~> 0.7)
json (~> 1.7, >= 1.7.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.5.2)
public_suffix (>= 2.0.2, < 4.0)
colorator (1.1.0)
ffi (1.9.18)
concurrent-ruby (1.0.5)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.5)
ffi (1.9.23)
forwardable-extended (2.6.0)
gemoji (3.0.0)
html-pipeline (2.6.0)
html-pipeline (2.7.1)
activesupport (>= 2)
nokogiri (>= 1.4)
htmlentities (4.3.4)
i18n (0.7.0)
jekyll (3.5.2)
http_parser.rb (0.6.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.7.3)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 0.7)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
jekyll-watch (~> 2.0)
kramdown (~> 1.14)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 1.7)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-sass-converter (1.5.0)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
jekyll-watch (2.0.0)
listen (~> 3.0)
jekyll_pages_api (0.1.6)
htmlentities (~> 4.3)
jekyll (>= 2.0, < 4.0)
jekyll_pages_api_search (0.4.4)
jekyll_pages_api_search (0.5.0)
jekyll_pages_api (~> 0.1.4)
sass (~> 3.4)
jemoji (0.8.0)
activesupport (~> 4.0)
jemoji (0.9.0)
activesupport (~> 4.0, >= 4.2.9)
gemoji (~> 3.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0)
json (1.8.3)
kramdown (1.15.0)
jekyll (~> 3.0)
kramdown (1.16.2)
liquid (4.0.0)
listen (3.0.8)
listen (3.1.5)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
mercenary (0.3.6)
mini_portile2 (2.1.0)
minitest (5.10.3)
nokogiri (1.6.8)
mini_portile2 (~> 2.1.0)
pkg-config (~> 1.1.7)
pathutil (0.14.0)
mini_portile2 (2.3.0)
minitest (5.11.3)
nokogiri (1.8.2)
mini_portile2 (~> 2.3.0)
pathutil (0.16.1)
forwardable-extended (~> 2.6)
pkg-config (1.1.7)
public_suffix (3.0.0)
rb-fsevent (0.10.2)
public_suffix (3.0.2)
rb-fsevent (0.10.3)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rouge (1.11.1)
rouge (3.1.1)
ruby_dep (1.5.0)
safe_yaml (1.0.4)
sass (3.5.1)
sass (3.5.5)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
thread_safe (0.3.5)
tzinfo (1.2.2)
thread_safe (0.3.6)
tzinfo (1.2.5)
thread_safe (~> 0.1)

PLATFORMS
Expand All @@ -90,4 +97,4 @@ DEPENDENCIES
uswds-jekyll!

BUNDLED WITH
1.15.4
1.16.1
14 changes: 7 additions & 7 deletions README.md
@@ -1,24 +1,24 @@
## Front End Guild
## Front-End Guild

18F promotes team best practices across specialty areas through guilds. These guilds support their members in whatever way deemed most appropriate by those members themselves.

This repo is where the 18F Front End Guild keeps its guide to best practices and resources for front end development.
This repo is where the 18F Front-End Guild keeps its guide to best practices and resources for front-end development.

### Quicklinks

- Guide: https://frontend.18f.gov/
- [CONTRIBUTING.md](CONTRIBUTING.md) on how to build this guide locally and submitting PRs/issues.

## Our mission
We believe that government websites should be functional, maintainable, and thoughtfully designed. Our guild helps TTS promote the adoption and advancement of front end design and development best practices. In this way, TTS can lead by example while providing effective services that help our partners and customers fulfill their missions.
To achieve our vision, the Front End Guild works to:
- Support the continuous learning necessary for successful front end work.
- Provide TTS developers with easy-to-understand, actionable guidance around front end best practices.
We believe that government websites should be functional, maintainable, and thoughtfully designed. Our guild helps TTS promote the adoption and advancement of front-end design and development best practices. In this way, TTS can lead by example while providing effective services that help our partners and customers fulfill their missions.
To achieve our vision, the Front-End Guild works to:
- Support the continuous learning necessary for successful front-end work.
- Provide TTS developers with easy-to-understand, actionable guidance around front-end best practices.
- Promote a central knowledge base of shared tools and common patterns.
- Create a healthy and supportive internal environment so that we can, in turn, bolster healthy external communities related to our work.

## How to track what we're doing, and how you can be involved!

We use issues in this repo to track work. If you'd like to suggest a new topic or flag an issue, please [file an issue](https://github.com/18F/frontend/issues/new/).

The front end space is rapidly changing, and our guide is a living document. Please suggest edits or changes via pull request.
The front-end space is rapidly changing, and our guide is a living document. Please suggest edits or changes via pull request.
28 changes: 5 additions & 23 deletions _config.yml
@@ -1,7 +1,6 @@
title: 18F Front End Guide
title: 18F Front-End Guide

styles:
- /assets/uswds/css/uswds.min.css
- /assets/css/styles.css

exclude:
Expand All @@ -14,29 +13,12 @@ exclude:

theme: uswds-jekyll

# Configuration for jekyll_pages_api_search plugin gem.
# jekyll_pages_api_search:
# Uncomment this to speed up site generation while developing.
#skip_index: true

# Each member of `index_fields` should correspond to a field generated by
# the jekyll_pages_api. It can hold an optional `boost` member as a signal
# to Lunr.js to weight the field more highly (default is 1).
# index_fields:
# title:
# boost: 10
# tags:
# boost: 10
# url:
# boost: 5
# body:
# results_page_title: Search results

defaults:
- scope:
path: "assets/uswds"
path: ""
type: "pages"
values:
skip_index: true
layout: page

permalink: pretty
markdown: kramdown
Expand All @@ -56,7 +38,7 @@ logoalt: 18F logo
google_analytics_ua: UA-48605964-19

repo:
name: Front End Guide
name: Front-End Guide
description: Main repository
url: https://github.com/18F/frontend

Expand Down
73 changes: 53 additions & 20 deletions _data/footer.yml
@@ -1,31 +1,64 @@
# Whether to show the "Return to top" link; can also be
# configured as an object with 'text' and 'href' properties.
top: true
# This is the configuration for the site footer.

# Which links to show at the top of the footer.
# This can key into _data/navigation.yml or a list of link objects
# with 'text' and 'href' properties.
# Configuration for type of footer.
# Footer types can be only be medium at the moment
type: medium

# Configuration for "Return to top" link.
# Customize with 'text' and 'href' properties.
# Comment out to the following section to hide.
top:
text: Return to top
href: '#'

# Configuration for "Edit this page" link in the footer.
# Customize with 'text' property.
# Uncomment the following line to show.
# edit_page:
# text: Edit this page

# Configuration for "Last updated" date and time.
# Uncomment the following line to show.
# last_updated: true

# Configuration for which links show at the top of the footer.
# this is a key into _data/navigation.yml
links:

# The optional heading for the footer.
# Configuration for footer heading. (optional)
heading:

# An array of agency logos to show, side by side, in the lower left
# of the footer on large screens.
# Configuration for agency logo(s) (shown side by side).
# If the logo is external add external: true
logos:
- src: /assets/images/18f-Logo.svg
alt: 18F

# Configuration for footer contact links
contact:
links:
# - text: USA
# href: https://usa.gov/

# Configuration for social media links
# Comment out links you don't want to use (RSS is an example)
social_links:
# - text: Facebook
# href: https://facebook.com
# external: true
# type: facebook
# - text: Twitter
# href: https://twitter.com
# external: true
# type: twitter
# - text: YouTube
# href: https://youtube.com
# external: true
# type: youtube
# - text: RSS Feed
# href: https://usa.gov/
# external: true
# type: rss
heading:

address: |
[18F USWDS-Jekyll theme](https://github.com/18F/uswds-jekyll)
Hosted by [Federalist](https://federalist.18f.gov/)
Maintained by [18F](https://18f.gsa.gov/)
# Configuration for contact links for email, phone, etc...
contact_links:
# - text: (800) CALL-GOVT
# href: tel:1-800-555-5555
# - text: info@agency.gov
# href: mailto:info@agency.gov
2 changes: 2 additions & 0 deletions _data/header.yml
Expand Up @@ -6,6 +6,8 @@
# _config.yml).
# title: Header title

usa_banner: true

primary:
# this is a key into _data/navigation.yml
links: primary
Expand Down
74 changes: 74 additions & 0 deletions _includes/components/footer--medium.html
@@ -0,0 +1,74 @@
{% if footer %}
<footer class="usa-footer usa-footer-medium" role="contentinfo">

{% if footer.last_updated %}
<div class="usa-grid">
<div class="usa-width-one-whole">
<p>Last updated: {{ page.last_modified_at | date: '%B %d, %Y at %I:%M %p' }}</p>
</div>
</div>
{% endif %}

{% if footer.top %}
<div class="usa-grid usa-footer-return-to-top">
<a href="{{ footer.top.href | default: '#' }}">{{ footer.top.text | default: 'Return to top' }}</a>
</div>
{% endif %}



{% if footer.links %}
{% assign footer_links = site.data.navigation[footer.links] | default: footer.links %}
{% assign _sizes = 'whole half third fourth sixth' | split: ' ' %}
{% assign _size = footer_links.size | minus: 1 %}
{% assign _size = _sizes[_size] | default: 'whole' %}
<div class="usa-footer-primary-section">
<div class="usa-grid">
<nav class="usa-footer-nav">
<ul class="usa-unstyled-list">
{% for _link in footer_links %}
<li class="usa-width-one-{{ _size }} usa-footer-primary-content">
<a class="usa-footer-primary-link" href="{% if _link.external == true %}{{ _link.href }}{% else %}{{ _link.href | relative_url }}{% endif %}">
{{ _link.text }}
</a>
</li>
{% endfor %}
</ul>
</nav>
</div>
</div>
{% endif %}

{% if footer.logos or footer.heading or footer.contact %}
<div class="usa-footer-secondary_section">
<div class="usa-grid">
<div class="usa-footer-logo usa-width-one-half">
{% if footer.logos %}
{% for logo in footer.logos -%}
{% if logo.url %}
<a href="{{ logo.url }}">
{% endif %}
<img class="usa-footer-logo-img" src="{% if logo.external %}{{ logo.src }}{% else %}{{ logo.src | relative_url }}{% endif %}" alt="{{ logo.alt }}"{% if logo.width %}width="{{ logo.width }}"{% endif %}{% if logo.height %}height="{{ logo.height }}"{% endif %}>
{% if logo.url %}
</a>
{% endif %}
{% endfor %}
{% endif %}

{% if footer.heading %}
<h3 class="usa-footer-logo-heading">{{ footer.heading }}</h3>
{% endif %}
</div>
<div class="usa-footer-contact-links usa-width-one-half">
<ul class="usa-unstyled-list">
<li><a href="https://github.com/18F/uswds-jekyll">18F USWDS-Jekyll theme</a></li>
<li>Hosted by <a href="https://federalist.18f.gov/">Federalist</a></li>
<li>Maintained by <a href="https://18f.gsa.gov/">18F</a></li>
</ul>
</div>
</div>
</div>
{% endif %}

</footer>
{% endif %}

0 comments on commit ed5ea1a

Please sign in to comment.