Skip to content

Commit

Permalink
re-create Handbook repository
Browse files Browse the repository at this point in the history
  • Loading branch information
afeld committed Aug 3, 2016
0 parents commit 5c3c26c
Show file tree
Hide file tree
Showing 226 changed files with 10,424 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .about.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
full_name: "18F Handbook"
name: handbook
owner_type: project
github:
- 18F/handbook

description: >
The 18F Handbook documents the mission, values, structures, policies, tools, and guides that shape our organization.
stage: live

links:
- url: https://handbook.18f.gov
text: 18F Handbook (live website)

# Email addresses of points-of-contact
contact:
- url: [email protected]
text: Nicole Fenton

team:
- id: nicole.fenton
github: nicoleslaw
role: lead
- id: michael.torres
github: mtorres253
role: contributor
- id: andrew.maier
github: andrewmaier
role: designer
- id: carlo.costino
github: ccostino
role: contributing engineer
- id: melody.kramer
github: melodykramer
role: former lead

stack:
- Jekyll
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.*.swp
.DS_Store
.bundle/
.jekyll*
.sass-cache/
_site/
5 changes: 5 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
language: ruby
rvm:
- 2.1.5
cache: bundler
script: ./go ci_build
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

## Where Contributions Go

Submit contributions to https://github.com/18F/handbook as a pull request. A member of the [handbook team](https://18f.slack.com/messages/18f-handbook) will check your request, offer comments if necessary, and then add it to the repo.

If you’re not comfortable submitting a pull request, feel free to [open an issue](https://github.com/18F/handbook/issues/new) with your suggestion or reach out in [#wg-onboarding](https://18f.slack.com/messages/wg-onboarding).

## Styles

This will be fleshed out in future iterations. For now, keep in mind that content appearing in the handbook should exemplify [best practices with regard to content](https://pages.18f.gov/content-guide/). Handbook content should be welcoming, personable, and free from jargon.

## 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.
14 changes: 14 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
source 'https://rubygems.org'

gem 'jekyll', '>=3.0'
gem 'redcarpet'
gem 'rouge'
gem 'go_script'

group :jekyll_plugins do
gem 'guides_style_18f'
end

group :development do
gem 'html-proofer'
end
95 changes: 95 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.6)
i18n (~> 0.7)
json (~> 1.7, >= 1.7.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.4.0)
colorator (0.1)
colored (1.2)
ethon (0.9.0)
ffi (>= 1.3.0)
ffi (1.9.10)
go_script (0.1.5)
bundler (~> 1.10)
safe_yaml (~> 1.0)
guides_style_18f (0.4.0)
jekyll
jekyll_pages_api
jekyll_pages_api_search
rouge
sass
html-proofer (3.0.6)
activesupport (~> 4.2)
addressable (~> 2.3)
colored (~> 1.2)
mercenary (~> 0.3.2)
nokogiri (~> 1.5)
parallel (~> 1.3)
typhoeus (~> 0.7)
yell (~> 2.0)
htmlentities (4.3.4)
i18n (0.7.0)
jekyll (3.0.1)
colorator (~> 0.1)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 3.0)
mercenary (~> 0.3.3)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-sass-converter (1.3.0)
sass (~> 3.2)
jekyll-watch (1.3.0)
listen (~> 3.0)
jekyll_pages_api (0.1.5)
htmlentities (~> 4.3)
jekyll (>= 2.0, < 4.0)
jekyll_pages_api_search (0.4.3)
jekyll_pages_api (~> 0.1.4)
sass (~> 3.4)
json (1.8.3)
kramdown (1.9.0)
liquid (3.0.6)
listen (3.0.5)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
mercenary (0.3.5)
mini_portile2 (2.1.0)
minitest (5.9.0)
nokogiri (1.6.8)
mini_portile2 (~> 2.1.0)
pkg-config (~> 1.1.7)
parallel (1.9.0)
pkg-config (1.1.7)
rb-fsevent (0.9.6)
rb-inotify (0.9.5)
ffi (>= 0.5.0)
redcarpet (3.3.3)
rouge (1.10.1)
safe_yaml (1.0.4)
sass (3.4.19)
thread_safe (0.3.5)
typhoeus (0.8.0)
ethon (>= 0.8.0)
tzinfo (1.2.2)
thread_safe (~> 0.1)
yell (2.0.6)

PLATFORMS
ruby

DEPENDENCIES
go_script
guides_style_18f
html-proofer
jekyll (>= 3.0)
redcarpet
rouge

BUNDLED WITH
1.12.5
31 changes: 31 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
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.

## 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.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
18F Handbook [![Build Status](https://travis-ci.org/18F/handbook.svg?branch=master)](https://travis-ci.org/18F/handbook)
========================

The [18F Handbook](https://handbook.18f.gov) documents the mission, values, structures, policies, tools, and guides that shape our team. This is a _living_ document and is updated regularly. If you have questions, comments, or suggestions, please
[open an issue](https://github.com/18F/handbook/issues). If you want to add content to the Handbook, please submit a pull request or ask in [#18f-handbook](https://18f.slack.com/messages/18f-handbook).

Note: If you're changing any kind of process, please let [#wg-onboarding](https://18f.slack.com/messages/wg-onboarding) know so we can keep the handbook, new hire messages, and checklists up to date.

# Development

``` bash
git clone https://github.com/18F/handbook.git
cd handbook
bundle install
./go serve
```

## Travel guide development
To add additional images:
* Add an image to the `images/travel` directory
* Link the image on the travel page, with folding HTML: `<img src="/images/travel/filename.png" class="travel-guide-hide">`
* A show/hide link will automatically be created.

To create a new page:
* Create a markdown file in the `_pages/policies/travel` directory
* Include a title and links to the "Travel Guide TOC" (see existing pages for reference)
* Update the page content
* Update the Travel Guide TOC `_pages/policies/travel/travel-guide-table-of-contents.md` with a link to your new page.
Loading

0 comments on commit 5c3c26c

Please sign in to comment.