GitHunt
CA

caleywoods/handbook

The home of policies and guidelines that make up TTS.

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

Docker

  1. Clone this repo
  2. Run docker compose up
  3. Open http://localhost:8080

Not Docker

To run the site locally:

  1. Clone this repo
  2. From the repo directory, run:
    npm install
    npm start
  3. Open http://localhost:8080

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 _img/travel directory.
  2. Link the image on the travel page, with folding code:
    {% image_with_class "_img/travel/filename.png" "travel-guide-hide" "description of the image" %}
  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.

Linting

We use Prettier to format Markdown. You can fix your
files locally with:

$ npm run lint

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.

Languages

HTML45.8%JavaScript42.8%SCSS10.6%Nunjucks0.6%Dockerfile0.2%
Other
Created February 4, 2025
Updated March 11, 2025
caleywoods/handbook | GitHunt