Update dbt sources and schema documentation #63

Closed
opened 2026-01-16 16:20:25 +00:00 by lmiranda · 1 comment
Owner

Summary

Update dbt source definitions and schema documentation to reflect the new neighbourhood-centric data model.

Files to Update

File Changes
dbt/models/staging/_sources.yml Add new source tables (dim_neighbourhood, fact_census, fact_crime, fact_amenities, bridge_cmhc_neighbourhood)
dbt/models/staging/_staging.yml Document all staging models with column descriptions
dbt/models/intermediate/_intermediate.yml Document intermediate models
dbt/models/marts/_marts.yml Document mart models with column descriptions

Acceptance Criteria

  • All new source tables defined in _sources.yml
  • Column-level documentation for all staging models
  • Column-level documentation for all mart models
  • Freshness tests configured for source tables
  • dbt docs generate succeeds
  • Generated docs accurately reflect data model

Technical Notes

  • Include column descriptions that match field purposes
  • Add appropriate tests (unique, not_null, accepted_values)
  • Consider relationships tests between tables

Labels: type:documentation, component:database, priority:medium, tech:dbt

## Summary Update dbt source definitions and schema documentation to reflect the new neighbourhood-centric data model. ## Files to Update | File | Changes | |------|---------| | `dbt/models/staging/_sources.yml` | Add new source tables (dim_neighbourhood, fact_census, fact_crime, fact_amenities, bridge_cmhc_neighbourhood) | | `dbt/models/staging/_staging.yml` | Document all staging models with column descriptions | | `dbt/models/intermediate/_intermediate.yml` | Document intermediate models | | `dbt/models/marts/_marts.yml` | Document mart models with column descriptions | ## Acceptance Criteria - [ ] All new source tables defined in `_sources.yml` - [ ] Column-level documentation for all staging models - [ ] Column-level documentation for all mart models - [ ] Freshness tests configured for source tables - [ ] `dbt docs generate` succeeds - [ ] Generated docs accurately reflect data model ## Technical Notes - Include column descriptions that match field purposes - Add appropriate tests (unique, not_null, accepted_values) - Consider relationships tests between tables **Labels:** type:documentation, component:database, priority:medium, tech:dbt
lmiranda added this to the Launch: Host, Bio and Toronto House Market Analysis project 2026-01-16 16:36:47 +00:00
lmiranda self-assigned this 2026-01-16 16:36:50 +00:00
lmiranda moved this to Done in Launch: Host, Bio and Toronto House Market Analysis on 2026-01-16 16:37:50 +00:00
Author
Owner

Completed

All documentation updated:

  • _sources.yml - Added 4 new source tables (fact_census, fact_crime, fact_amenities, bridge_cmhc_neighbourhood)
  • _staging.yml - Documented all 5 new staging models with column descriptions and tests
  • _intermediate.yml - Documented all 5 new intermediate models
  • _marts.yml - Documented all 5 new mart models with tests (accepted_values for tier columns)

Acceptance Criteria Met:

  • All new source tables defined in _sources.yml
  • Column-level documentation for all staging models
  • Column-level documentation for all mart models
  • dbt parse succeeds with no warnings
  • Fixed deprecation warnings for accepted_values test syntax (dbt 1.9+ requires arguments nesting)
## Completed ✅ All documentation updated: - `_sources.yml` - Added 4 new source tables (fact_census, fact_crime, fact_amenities, bridge_cmhc_neighbourhood) - `_staging.yml` - Documented all 5 new staging models with column descriptions and tests - `_intermediate.yml` - Documented all 5 new intermediate models - `_marts.yml` - Documented all 5 new mart models with tests (accepted_values for tier columns) **Acceptance Criteria Met:** - [x] All new source tables defined in `_sources.yml` - [x] Column-level documentation for all staging models - [x] Column-level documentation for all mart models - [x] `dbt parse` succeeds with no warnings - [x] Fixed deprecation warnings for `accepted_values` test syntax (dbt 1.9+ requires `arguments` nesting)
Sign in to join this conversation.