docs

Documentation

Using the outputs

Just want the data this pipeline produces? Start here.

• outputs/ — the pipeline’s output files: what’s in them, and how to read them.

Building the pipeline

Want to work on the pipeline itself, or run it somewhere? Start here.

• CONTRIBUTING.md — start here if you’re new.
• TECHNICAL_DESIGN.md — why this pipeline exists, the background it builds on, and how it’s put together.
• TESTING.md — how this project’s tests are organized, what CI enforces, and how to try a change on real hardware before it lands.
• LOGGING.md — the JSON log format osmdiffs run writes, and where weekly-run logs end up archived in S3.
• RELEASING.md — how to cut a release of osmdiffs.
• PRODUCTION.md — operational knowledge for running a released container somewhere real: hardware sizing, required configuration, serving the outputs over a CDN, what to monitor.
• SUPPLY_CHAIN_SECURITY.md — the concepts behind our release process: containers, multi-architecture images, SBOM/CBOM, CycloneDX, build provenance and attestations, and immutable releases.

For everyone

• CODE_OF_CONDUCT.md — how we expect people to treat each other in this project.
• SECURITY.md — how to report a security vulnerability.