dbt_fivetran_utils icon indicating copy to clipboard operation
dbt_fivetran_utils copied to clipboard

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

Open fivetran-jamie opened this issue 2 years ago • 1 comments

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:

  • [ ] source_relation
  • [ ] _fivetran_deleted
  • [ ] is_deleted (hubspot has good definitions for this)
  • [ ] _fivetran_id
  • [ ] _fivetran_synced

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

  • [ ] created_at
  • [ ] updated_at
  • [ ] index

fivetran-jamie avatar Jan 25 '23 23:01 fivetran-jamie

@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?

fivetran-joemarkiewicz avatar Jan 27 '23 22:01 fivetran-joemarkiewicz