aaronpava/handbook

The home of policies and guidelines that make up 18F.

18F Handbook

The 18F Handbook 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. If you want to add content to the Handbook, please submit a pull request or ask in #18f-handbook.

Note: If you're changing any kind of process, please let #wg-onboarding know so we can keep the handbook, new hire messages, and checklists up to date.

What can't be included

For 18F staff, keep in mind that the handbook website and repository are public, so we can't include information that shouldn't be public. We already get training on this, but here are a few reminders about things we shouldn't include here:

• Sensitive information, as described in our Open Source Policy practices guide
• Comments that can be easily interpreted as endorsements (or other potential ethical issues)

We avoid including information that can easily go out of date and is already published somewhere else in a useful format. This includes:

• People's phone numbers, even if public information (such as their GSA work number). Link to the public GSA staff directory or the access-controlled 18F contact spreadsheet instead of including phone numbers in the handbook.
• Information that is already well-covered on GSA InSite. Link there instead of reproducing it.
• Specific 18F org chart info (such as lists of names of supervisors and facilitators). Link to the internal 18F org chart instead.

We're careful about publishing information collected during research; learn more and ask #research for guidance first.

Development

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

See the 18F Pages documentation to learn how to make a new page and add it to the homepage navigation links.

Travel guide development

To add additional images:

1. Add an image to the images/travel directory.
2. Link the image on the travel page, with folding HTML: <img src="/images/travel/filename.png" class="travel-guide-hide">.
3. A show/hide link will automatically be created.

To create a new page:

1. Create a markdown file in the _pages/policies/travel directory.
2. Include a title and links to the "Travel Guide TOC" (see existing pages for reference).
3. 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.