Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 2.61 KB

README.md

File metadata and controls

56 lines (34 loc) · 2.61 KB
Raw

TTS Handbook CircleCI

The TTS 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 #tts-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.

Development

To run the site locally:

  1. Install Docker for Mac.

  2. Clone this repository.

  3. From this repository directory, run:

    docker-compose up --build

  4. Open http://localhost:4000

Contributing

If you are interested in contributing to this repository, you can read more at CONTRIBUTING.

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.

Internal links

For internal links, use {{site.baseurl}} in the URL (in place of https://https://handbook.18f.gov) to make links work correctly in Federalist previews as well as in production.

✨ Good: ({{site.baseurl}}/code-of-conduct/)

🚫 Instead of: (/code-of-conduct/)

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.