Skip to content
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

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

Open
8 tasks
fivetran-jamie opened this issue Jan 25, 2023 · 1 comment
Open
8 tasks
Labels
type:enhancement New functionality or enhancement

Comments

@fivetran-jamie
Copy link
Contributor

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-joemarkiewicz
Copy link
Contributor

@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 fivetran-joemarkiewicz changed the title Add package-agnostic docs definitions only once (here) [FEATURE] - Add package-agnostic docs definitions only once (here) Feb 23, 2024
@fivetran-joemarkiewicz fivetran-joemarkiewicz added the type:enhancement New functionality or enhancement label Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement New functionality or enhancement
Projects
None yet
Development

No branches or pull requests

3 participants