Missing docs for resource types + general configs

[dbeatty10]

Contributions

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

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

See below.

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

There is a many-to-many relationship between resource types and general configs. Each resource type has its own docs page as does each general config. These pages should refer to each other both(!) directions when a general config is applicable to a particular resource type.

The ✅ below is when a link exists in at least one direction, and the ☑️ are when something is linked one direction, but not the other.

⚠️ The tables below only point out where there is internal inconsistency; it does not highlight any potential instances where existing links are incorrect or utterly incomplete.

Look at it one direction

The ☑️ below indicate that a general config page (like enabled contains an example for a resource type (like metrics), but the config page for the resource type is missing a similar example.

	models	seeds	snapshots	tests	sources	analyses	exposures	macros	metrics
enabled	✅	✅	✅	✅	✅		✅		☑️
tags	✅	✅	✅	✅		✅
pre-hook	✅	✅	✅
pre-hook	✅	✅	✅
database	✅	✅		✅
schema	✅	✅		✅	☑️
alias	✅	✅	✅	✅
persist_docs	✅	✅	✅		☑️
full_refresh	✅	✅
meta	✅	✅	☑️	✅	☑️	☑️		☑️
grants	✅	✅	✅
contract	✅

Look at it the other direction

The ☑️ below indicate that a resource type page (like analyses) contains an example for a general config (like tags, but the page for the general config is missing a similar example.

	models	seeds	snapshots	tests	sources	analyses	exposures	macros	metrics
enabled	✅	✅	✅	✅	✅		✅		✅
tags	✅	✅	✅	☑️		☑️
pre-hook	✅	✅	✅
pre-hook	✅	✅	✅
database	☑️	✅		☑️
schema	☑️	☑️		☑️	✅
alias	☑️	✅	☑️	☑️
persist_docs	✅	✅	✅		✅
full_refresh	✅	✅
meta	✅	✅	✅	✅	✅	✅		✅
grants	✅	✅	✅
contract	✅

Additional information

No response

[runleonarun]

This is such a helpful way of looking at it Doug!

[mirnawong1]

Mirna to hardcode table

[dbeatty10]

Note: these tables are just showing the docs pages that currently exist (or not) -- they are not necessarily fully showing the which configs are available for each resource type. But creating such a table could be helpful too!

[mirnawong1]

hey @dbeatty10 , i've dug into this a little bit and if I'm not mistaken, it looks like the following docs need adding so they link to each other. however, there are some resources where it's either not supported or under the 'properties' page:

action needed

• schema -> source = need to add link to source properties example)
• meta - macros = need to add link to meta on this page
• meta -> snapshots = add link to snapshot properties in meta page for meta value
• meta -> sources = add link to sources properties in meta page for meta value.

no action needed

• persist docs - source = not supported so seems like no linking is needed
• meta - analyses = The meta config is not currently supported for analyses. so seems like no linking is needed