--- title: "Data Source Page Template" description: "Canonical structure for every page under docs/data-sources. Copy this file when adding a new dataset." tags: [internal, template] --- {/* This file is a CONTRIBUTOR SCAFFOLD, not a public page. The leading underscore on the filename keeps Docusaurus from routing it (same convention as `_confirmed-datasets.md`). Copy it to `.md`, drop the leading underscore, fill in the placeholders, delete this comment, and you're done. */} # <Data Source Name> **<One-line value proposition / "Powered by ..." tagline>** <Two or three plain-language sentences describing what this dataset is and why a civic user or developer would reach for it. Avoid jargon in this paragraph — later sections are the place for technical depth.> :::info At a glance | | | |---|---| | **Provider** | <organization / agency> | | **Coverage** | <geographic + temporal scope> | | **Update cadence** | <daily / quarterly / annual / static> | | **License** | <SPDX id or short name> · see [Legal](../legal/index.md) | | **Cost** | <free / API key / paid tier> | | **Access method** | <REST API / GraphQL / bulk download / scrape / HF dataset> | | **Our pipeline** | <bronze table · dbt model · loader script path> | ::: ## Overview <What the source actually contains and how Open Navigator uses it. Two to four short paragraphs is plenty — keep deep field-level detail for the next section.> ## Data available ### Fields <One row per useful field. The `Coverage` column is the house style — fill it with `100%`, `~80%`, `Rated orgs only`, etc. so readers can see at a glance which fields are reliable.> | Field | Description | Type | Coverage | |-------|-------------|------|----------| | **<field_name>** | <what it is> | `string` | 100% | | **<field_name>** | <what it is> | `integer` | ~80% | ### Grain & keys - **Grain:** <one row per ...> - **Primary key:** `` - **Joins to:** <other dataset(s) and on which key> ## How we ingest it ```bash # Loader / dbt entry point — keep this runnable and current. ``` - **Source:** <url / endpoint / bucket> - **Lands in:** `bronze.` → `` → `` - **Refresh:** <how a contributor re-pulls it> ## Coverage & known gaps <Honest limitations: missing geographies, lag, partial fields, rate limits, deprecated endpoints. Readers trust pages more when the warts are up top.> ## Licensing & attribution <Required attribution text, redistribution terms, trademark notices, and a link to the provider's full terms. If the provider mandates link-back HTML, include the exact snippet.> ## Related - [<related data source>](./.md) - [Data model ERD](./data-model-erd.md) - [Citations](./citations.md)