Skip to content

Start here

Pick the path that matches your role. Each path is an ordered reading list of existing pages; read them in order and stop when you have what you need. Unfamiliar terms are defined in the glossary.

Data consultant

You want to know whether the kit is a sound base for client work, what it costs to try, and what you may do with it.

  1. Overview: what the two editions contain and how to choose one.
  2. FAQ: short answers on cost, data, credentials, licence, and what has been tested.
  3. Decision 0001: licence and data terms: why the licence is source-available and what needs a separate written licence.
  4. Notice and attribution: how the TheLook public dataset is credited and why no rows ship with the kit.
  5. Mart contract: which metrics match across editions and which are edition-specific.
  6. BigQuery architecture or Snowflake architecture: one diagram of sources, models, CI, and docs.
  7. Cost control guardrails: which warehouse controls to set before a run, and what each one does not cover.
  8. Compatibility: the pinned Python, dbt, and adapter versions and what has actually run.
  9. Edition workspaces: how to copy one edition into a clean client workspace.
  10. Support: the best-effort support baseline.

Analyst

You want to understand the marts, what each row means, and how to report on them.

  1. Overview: choose the edition whose data fits your question.
  2. Glossary: grain, mart, staging, and the other terms used below.
  3. First-run walkthrough: the data flow and example queries for both editions.
  4. Mart contract: the grain, inputs, and metric definitions of every mart.
  5. BigQuery overview: business metric definitions for the TheLook marts.
  6. Looker Studio walkthrough: connect the BigQuery marts and build four charts.
  7. BigQuery dbt docs or Snowflake dbt docs: browse model descriptions, columns, and the lineage graph.
  8. FAQ: what is real data, what is synthetic, and whether the editions are equivalent.

Analytics engineer

You want to run an edition, change it safely, and extend it.

  1. First-run walkthrough: prerequisites and the run sequence for each edition.
  2. BigQuery setup or Snowflake setup: profile, credentials, and the first dbt build.
  3. BigQuery architecture or Snowflake architecture: how sources, staging, marts, CI, and docs connect.
  4. Mart contract: the grains and definitions to preserve when you add models.
  5. BigQuery overview: the optional incremental mart and its lookback window.
  6. Snowflake operations and adapting the kit: warehouse controls, the CI boundary, and replacing the seeds.
  7. Operations and observability: inspecting runs, freshness, and artifact retention.
  8. Source change contract: what to agree about a source before building an incremental model on it.
  9. Medallion migration and migration loader: the optional Bronze, Silver, and Gold path and its current limits.
  10. Cloud acceptance runbook and Terraform lifecycle: provisioning a disposable target and running the preflight before any warehouse run.
  11. CI security review: the trust boundaries of each workflow.
  12. Contributing: repository conventions for SQL, YAML, tests, and commits.