TTS Handbook

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

Clone this repo
Run docker compose up
Open http://localhost:8080

Not Docker

To run the site locally:

Clone this repo
Run npm install
From the repo directory, run:
```
npm install
npm run dev
```
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:

Add an image to the _img/travel directory.
Link the image on the travel page, with folding HTML: <img src="{% image "_img/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.

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.

yaseenaljamal/handbook