Skip to content

Add model properties yml and basic documentation #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

risafangs
Copy link
Contributor

@risafangs risafangs commented Nov 20, 2024

What

  • Added yml files to staging models so that I could document them
  • Added a markdown file to store definitions that are referenced in multiple models (docs/common_fields.md)
  • Adjusted dbt_project.yml to look for docs in docs-paths
  • Summaries for each file sourced from here: https://www.fec.gov/data/browse-data/?tab=bulk-data
  • For individual columns, the file descriptions are sometimes not that descriptive. I found more detailed descriptions of some data points in the API documentation.

Why

The model descriptions/descriptions of each file are helpful for data navigation. I started adding column descriptions for the candidates and committees files based on what’s available in the FEC data descriptions but many of the columns are not fully defined there.

@risafangs risafangs changed the title Feature/add model docs Add model properties yml and basic documentation Nov 20, 2024
Copy link

github-actions bot commented Dec 6, 2024

Recce Summary

Manifest Information

Manifest Catalog
Base 2024-12-06 03:10:58 2024-12-06 03:10:58
Current 2024-12-06 03:11:11 2024-12-06 03:11:12

Lineage Graph

No changed module was detected.

Checks Summary

Checks Run Data Mismatch Detected
2 0

See PR page: https://cloud.datarecce.io/DataRecce/TodoFEC-dbt/pulls/23

Next Steps

To view detailed Recce results:

  1. Checkout the PR branch: git checkout feature/add-model-docs
  2. Launch the Recce server: recce server --review --cloud
  3. Open http://localhost:8000 in your browser

@risafangs risafangs marked this pull request as ready for review December 18, 2024 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant