coreycaitlin / handbook

The home of policies and guidelines that make up Bloom

BLOOM EMPLOYEE HANDBOOK

We've prepared this handbook to specify what Bloomers can expect from Bloom Works and what we expect from Bloomers. It describes the Bloom philosophy, working methods and processes, employment practices, policies, and benefits.

Developer Setup

Local environment

1. Install Python 3.x
2. pip install mkdocs
3. mkdocs serve
4. View the site at https://127.0.0.1:8000

Docker/VSCode environment

This lets you spin up a dev environment via Docker within VSCode, which keeps your system clean.

1. Install VSCode, Remote Extension plugin (for VSCode), and Docker for Desktop.
2. Launch Docker
3. Open the project in VSCode
4. Open in the container specified by Dockerfile.dev
5. Run mkdocs serve
6. View the site at https://127.0.0.1:8000

License

Copyright 2021 Bloom Works.

This work is licensed under the terms of the Creative Commons Attribution 4.0 International (CC BY 4.0) license.

Acknowledgements

We'd like to thank the folks at 18F and Civic Actions for their handbooks, from which this documentation was forked. We welcome you to fork our documentation, or use the 18F handbook, which is licensed as CC0.

When adding documents

How to add images and live links

Text

Links to reference for coding purposes

How to add GDoc thumbnails How to create an index for ordering pages General read the docs help