Contributing to the Handbook
So you want to contribute to the Handbook? Great! We’re glad you’re here. This project is fully crowd-sourced, and thus its success hinges on whether people like you correct typos, update stale content, or make pages more readable.
How to update the handbook
Everyone, inside and outside TTS, can submit contributions to https://github.com/18F/handbook as a pull request or open an issue with a suggestion. If you’re part of TTS, you can also chat about ideas in #tts-handbook.
There is no dedicated staff for the handbook; maintenance is done by TTS staff who are interested in helping.
For long or important chunks of writing, consider asking the 18F Writing Lab to review and edit before you propose significant changes to the handbook.
Before you make your contribution, there are a few things to remember:
- This handbook website and repository are public
- We’re careful about publishing information collected during research; learn more and ask #g-research for guidance first
- Try to avoid “click here” links. If necessary, be sure to follow the A11Y Project Anchor Link Patterns.
- TTS-wide information should be public by default and link to Google Docs for anything that shouldn’t be publicly visible.
- We follow the structure outlined in the 18F Content Guide
There is also some information that should not be included in the Handbook:
TTS staff should not include information that shouldn’t be public.
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 TTS org chart info (such as lists of names of supervisors and facilitators). Link to the TTS org chart, the internal 18F org chart, or the internal Office of Solutions org chart instead
Creating a new page?
If you plan on creating a new Handbook page, first check out the page templates. If the type of content you’re creating – for example, if you’re documenting a new tool – has a template, then please use it to write your new page.
Now, assuming you’ve identified what you want to contribute – if you haven’t, check out the Handbook’s open issues – let’s talk about the mechanism by which you’ll contribute: NetlifyCMS or Git.
Contributing via NetlifyCMS (Experimental)
NetlifyCMS is a Git-based content management system (CMS) that provides a Google Docs-like interface for editing content. In other words, this means that you won’t need to know anything about (a) Git, (b) Markdown, or (c) web development to make your contribution.
If you’d rather stick with the Git way of editing content, see below.
Note: The following steps specifically cover editing an existing page.
Step 1: Access NetlifyCMS
To access NetlifyCMS for the Handbook, navigate to https://handbook.tts.gsa.gov/admin/. If you haven’t made a contribution before, NetlifyCMS will prompt you to login with GitHub. If you don’t have a GitHub account, create one.
Step 2: Find the page you’d like to edit
Using the search feature, search by the title of the page you are looking to edit. It should come up in the results; click it to open the editor.
Step 3: Make your changes and save
NetlifyCMS lets you edit content in either Rich Text or Markdown, so feel free to use whichever makes you feel more comfortable. When you’re done making your changes, click the ‘Save’ button at the top of your screen. Note: NetlifyCMS does not offer auto-saving at this time.
When you save for the first time, a pull request will be automatically opened.
Action Item: You should change the title and body of the pull request to make more sense, since it will be pre-filled by NetlifyCMS.
Step 4: Update the status of your change from ‘Draft’ to ‘In Review’
We’ve enabled the “editorial workflow” feature of NetlifyCMS, which allows content editors to more easily track the status of proposed changes. When you first click save, your changes will have ‘Status: Draft’ attached. Once you feel that your changes are ready for others’ review, use the dropdown to change the status to ‘In review’.
You can also change the status by using a Trello-like board found at https://handbook.tts.gsa.gov/admin/#/workflow. To change the status, simply drag the card associated with your changes from the ‘Drafts’ column to the ‘In Review’ column.
Step 5: See your changes through!
At this point, your changes should be officially marked as ready for review – great work! You should hear back from certain content owners regarding your changes; they should work with you to get your change merged into the main Handbook repository.
At the time of writing, the review process is primarily handled in GitHub. If you aren’t familiar with this tool, that’s okay – see our Intro to GitHub for a brief primer. For most people, the important things to know in GitHub are: (a) how to login, (b) how to comment, request changes, or approve pull requests, and (c) how to create issues.
- Access the build preview directly: At the top right hand side of NetlifyCMS, click ‘View Preview’ to see your changes deployed on a live, mock Handbook, courtesy of cloud.gov Pages. Check out the build preview docs for more information on this feature.
Contributing via Git
Random technical details:
The Handbook has a special
questions front matter variable for pages:
questions: - name-of-slack-channel - firstname.lastname@example.org - text: The text to display url: https://somesite.gov
It is optional, and can contain one or more Slack channel name, email address, and/or link.
We use Prettier to enforce a standard formatting for all Markdown files. If code is pushed to GitHub and is not well-formatted via Prettier, it will automatically be fixed by a bot; you have the option to run Prettier locally before pushing to avoid this extra commit, but it is not required.
Fork or branch?
Forking and branching are two ways of submitting pull requests to edit the Handbook.
If you are using the GitHub website built-in editing features, you do not have to choose: GitHub will make the correct choice for you.
If you are using your Terminal / local git to edit:
- TTS teammates: Please use branching to submit pull requests. Federalist Preview sites will only be built from a branch, and continuous integration can only succeed for PRs created from branches.
- External contributors: Please use forking to submit pull requests, since non-TTS contributors do not have write access. Unfortunately, we won’t be able to run Federalist Preview sites for your pull request; please build and serve the site locally to test instead.
If you have any questions, feel free to ask in #tts-handbook.
Thank you so much for your contributions! :tada:
New files should be created in the
_pages directory and in the sub-directory that makes the most sense for your content. For example, a new page on an 18F process should go in the
Pull requests (PRs)
Each pull request should be reviewed by at least one other TTS staff member before merging. Once a PR is approved, anyone can merge it (including the original submitter).
If you make a pull request that’s best reviewed by a specific person, tag or assign it to that person. It can also help to ping them in Slack to ask for review.
The TTS Handbook uses the GitHub “code owners” feature to automatically add content owners as a reviewer. This means that in most cases, you as a contributor should not need to manually add anyone for a review.
If you suspect that the wrong team was added as a reviewer, feel free to open a pull request to change the CODEOWNERS file, located at the top level of the project.
How to review and merge pull requests
Any TTS staff member can review a pull request. If it’s not your area of expertise, ask somebody who has expertise in that area (for instance, by commenting to tag a person or sharing the PR in Slack). If the author of the pull request added a specific person as a reviewer, hold off merging the pull request until at least one specified reviewer has had a chance to review it.
A note to submitters: If you need multiple people to see your PR before it’s merged, please add a comment letting reviewers know!
If you’re not sure, ask for a second opinion in #tts-handbook first.
If you’re reviewing a pull request made using NetlifyCMS
Pull requests made using NetlifyCMS should only be reviewed when the label is changed from
Using repo specific labels
- do not merge yet: Delay merging this pull request until the label has been removed
- help wanted: Need additional assistance
- In progress: Currently being worked on
- info is incorrect/outdated: The current information that is there needs tending to
- new content needed: There is information that is not present that should exist
- <2 hours: Easy peazy, lemon squeezy
- 2-4 hours: Hold my callz
- >4 hours: Ooph, its a doozy!
Content and accessibility
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.