fivetran / dbt_fivetran_utils

Helper utils for our packages
29 stars 19 forks source link

[FEATURE] - Add package-agnostic docs definitions only once (here) #97

Open fivetran-jamie opened 1 year ago

fivetran-jamie commented 1 year ago

Just tested this locally -- if we create a models folder to this package and add a docs.md file with definitions, all other packages that depend on this one will be able to access those descriptions. We can also put the docs file in the macros folder according to this.

There are plenty of fields we use across the board:

And maybe some common types of fields that we can generalize the definition to:

fivetran-joemarkiewicz commented 1 year ago

@fivetran-jamie I absolutely love this idea!! If a docs.md exists in a package already, is there any conflict that possibly occurs with the two docs files? Or does it just sort itself out?