Create docs/runbooks/adding-dashboard.md #87

Closed
opened 2026-01-17 21:53:47 +00:00 by lmiranda · 0 comments
Owner

Overview

Create a runbook documenting the step-by-step process for adding a new dashboard to the application.

Acceptance Criteria

  • Create docs/runbooks/adding-dashboard.md
  • Document directory structure requirements
  • Include required files checklist:
    • Page module (pages/{name}/dashboard.py)
    • Tab layouts (pages/{name}/tabs/)
    • Callbacks (pages/{name}/callbacks/)
    • Schemas ({name}/schemas/)
    • Models ({name}/models/)
    • Parsers/Loaders ({name}/parsers/, {name}/loaders/)
  • Document dbt model requirements
  • Use step-by-step checklist format
  • Include example code snippets where helpful
  • Reference existing Toronto dashboard as example

Technical Notes

Structure should cover:

  1. Planning phase (data sources, metrics, visualizations)
  2. Data layer (schemas, models, parsers, loaders)
  3. dbt models (staging, intermediate, marts)
  4. Application layer (pages, tabs, callbacks, figures)
  5. Testing requirements
  6. Documentation updates

Labels

  • Type/Documentation
  • Priority/Medium
  • Complexity/Medium
  • Component/Docs

Phase: 4 - Runbooks

## Overview Create a runbook documenting the step-by-step process for adding a new dashboard to the application. ## Acceptance Criteria - [ ] Create `docs/runbooks/adding-dashboard.md` - [ ] Document directory structure requirements - [ ] Include required files checklist: - [ ] Page module (`pages/{name}/dashboard.py`) - [ ] Tab layouts (`pages/{name}/tabs/`) - [ ] Callbacks (`pages/{name}/callbacks/`) - [ ] Schemas (`{name}/schemas/`) - [ ] Models (`{name}/models/`) - [ ] Parsers/Loaders (`{name}/parsers/`, `{name}/loaders/`) - [ ] Document dbt model requirements - [ ] Use step-by-step checklist format - [ ] Include example code snippets where helpful - [ ] Reference existing Toronto dashboard as example ## Technical Notes Structure should cover: 1. Planning phase (data sources, metrics, visualizations) 2. Data layer (schemas, models, parsers, loaders) 3. dbt models (staging, intermediate, marts) 4. Application layer (pages, tabs, callbacks, figures) 5. Testing requirements 6. Documentation updates ## Labels - Type/Documentation - Priority/Medium - Complexity/Medium - Component/Docs ## Phase: 4 - Runbooks
Sign in to join this conversation.