Review the structure of resource-specific and general configs pages #4510
Labels
content
Improvements or additions to content
improvement
Use this when an area of the docs needs improvement as it's currently unclear
Contributions
Link to the page on docs.getdbt.com requiring updates
Following on from the discussion in PR #4448, this issue sets to address the existing structure and layout of the config pages, specifically resource-specific and general configs content. For example, model configs
@dbeatty10 suggests the following:
Radical alternative
So one radical alternative would be to combine the resource-specific and general configs into a single section and then no additional explanations are even needed.
For seeds, the combined listing for dbt_project.yml might look like this (either give or take the inline comments):
seeds:
:
History
Here are the pull requests where these separate headings originally appeared for each different resource types:
#111
#158
#162
#705
See also
#3964 has some tables showing which general configs apply to which resources. It does not contain any resource-specific configs.
Mirna's perspective
I think combing them is a great idea, however i do think doing that is still not explicit enough for users. i like the idea of being more explicit so users have more insight into how they can apply each type of config for their own use case, as oppose to inferring it somehow in the comments of header (currently it's inferred via the header, i think).
I've tried to also make it clearer that the resource-specific config is only available that source using props but it's not working for me so I'm going to investigate more
What part(s) of the page would you like to see updated?
These are the following pages:
https://docs.getdbt.com/reference/model-configs
https://docs.getdbt.com/reference/seed-configs
https://docs.getdbt.com/reference/snapshot-configs
https://docs.getdbt.com/reference/test-configs
https://docs.getdbt.com/reference/source-configs
Additional information
No response
The text was updated successfully, but these errors were encountered: