-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Support descriptions on seeds, snapshots in .yml files #1974
Comments
I like to think of |
I just ran into this myself on some work I've been doing. Thanks for documenting this issue. Like @clrcrl, I also don't have super-strong opinions here, although my initial reaction is to call out the different resource types in the yml tree specifically like you suggested @drewbanin -- they could definitely have different properties in the future. The thing that this ties into for me, though, is the
We've talked for a long time about unifying dbt commands such that |
…ryone Make dbt support documentation for snapshots and seeds (and analyses) (#1974)
Fixed in #2051 |
Describe the bug
Seeds can be tested in .yml files, but they can not be documented there. While supporting a
description
field for seeds in the manifest might be straightforward, the bigger thing to tackle here is the lack of clarity around the schema.yml spec. Right now, nodes can be defined under one ofsources:
ormodels:
.It's not obvious that seed files (and snapshots) should be defined under
models:
. Should dbt instead support other top-level keys likeseeds:
andsnapshots:
? It's conceivable that each of these resource types would support their own configurations, so separating them out could make parsing the schema.yml file (and surfacing syntax errors to users) simpler. You can also imagine this paradigm extending to document macros.Expected behavior
Descriptions on seeds and snapshots should be populated in the rendered documentation site.
The output of
dbt --version
:The text was updated successfully, but these errors were encountered: