Skip to content
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

Narrative: Model contracts #2839

Closed
1 task done
Tracked by #6747
jtcohen6 opened this issue Feb 9, 2023 · 0 comments · Fixed by #2890
Closed
1 task done
Tracked by #6747

Narrative: Model contracts #2839

jtcohen6 opened this issue Feb 9, 2023 · 0 comments · Fixed by #2890
Labels
content Improvements or additions to content dbt-core v1.5 Docs impact for the v1.5 release (Apr 2023) improvement Use this when an area of the docs needs improvement as it's currently unclear Initialize Docs are ready for framework size: large This change will more than a week to address and might require more than one person

Comments

@jtcohen6
Copy link
Collaborator

jtcohen6 commented Feb 9, 2023

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

What part(s) of the page would you like to see updated?

Full motivation & context in:

Our docs should seek to cover:

  • What is a "model contract"?
  • For which of my models should I define contracts?
  • How do the capabilities of contracts differ across data platforms?
  • When should I use contracts, versus / in addition to tests?

Additional information

The first cut of these docs in:

We're planning more changes, on top of that initial implementation / foundation. We need to call out that the initial implementation is preliminary and liable to change.

Those changes are being tracked in this "epic" issue:

We'll open more narrowly scoped issues associated with specific pieces of dbt-core functionality, as we merge those in.

@jtcohen6 jtcohen6 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear dbt-core v1.5 Docs impact for the v1.5 release (Apr 2023) blocked_by_dev Awaiting merge of PR with associated functionality labels Feb 9, 2023
@jtcohen6 jtcohen6 added this to the dbt Core v1.5 Documentation milestone Feb 9, 2023
@jtcohen6 jtcohen6 added the size: large This change will more than a week to address and might require more than one person label Feb 9, 2023
@matthewshaver matthewshaver added the Initialize Docs are ready for framework label Feb 16, 2023
@jtcohen6 jtcohen6 changed the title Model contracts Narrative: Model contracts Feb 16, 2023
@jtcohen6 jtcohen6 removed the blocked_by_dev Awaiting merge of PR with associated functionality label Feb 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content dbt-core v1.5 Docs impact for the v1.5 release (Apr 2023) improvement Use this when an area of the docs needs improvement as it's currently unclear Initialize Docs are ready for framework size: large This change will more than a week to address and might require more than one person
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants