https://github.com/2i2c-org/team-compass
Organizational strategy, structure, policy, and practices across 2i2c.
https://github.com/2i2c-org/team-compass
governance non-profit team
Last synced: about 1 year ago
JSON representation
Organizational strategy, structure, policy, and practices across 2i2c.
- Host: GitHub
- URL: https://github.com/2i2c-org/team-compass
- Owner: 2i2c-org
- Created: 2020-11-19T00:58:44.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-04T21:06:22.000Z (over 1 year ago)
- Last Synced: 2025-04-11T21:11:53.502Z (about 1 year ago)
- Topics: governance, non-profit, team
- Language: Python
- Homepage: https://compass.2i2c.org
- Size: 8.57 MB
- Stars: 4
- Watchers: 12
- Forks: 13
- Open Issues: 162
-
Metadata Files:
- Readme: README.md
- Code of conduct: code-of-conduct/index.md
Awesome Lists containing this project
README
# 2i2c Team Compass
This repository contains the source files for the [2i2c Team Compass](https://team-compass.2i2c.org).
For more information, see [our Team Compass landing page](https://team-compass.2i2c.org).
## Build the team compass locally
The Team Compass is built with [the Sphinx documentation engine](https://sphinx-doc.org).
The easiest way to build the documentation in this repository is to use [the `nox` automation tool](https://nox.thea.codes/), a tool for quickly building environments and running commands within them.
This ensures that your environment has all the dependencies needed to build the documentation.
To do so, follow these steps:
1. Install `nox`
```console
$ pip install nox
```
2. Build the documentation:
```console
$ nox -s docs
```
This should create a local environment in a `.nox` folder, build the documentation (as specified in the `noxfile.py` configuration), and the output will be in `_build/dirhtml`.
To build live documentation that updates when you update local files, run the following command:
```console
$ nox -s docs-live
```
## Organization Secrets
This repo requires access to organizational-level secrets that cannot be access via forked PR. Therefore the GH action `test-docs.yaml` will fail unless you push a non-forked PR.