search

gouline / dbt-metabase

dbt + Metabase integration
https://pypi.org/project/dbt-metabase/
MIT License
442 stars 63 forks source link

Better Documentation #84

Closed soltanianalytics closed 2 years ago

soltanianalytics commented 2 years ago

I'd wager that the usability and prevalence of this marvelous packages would be greatly advanced if there was a basic documentation to go along with the two major models (MetabaseInterface and DbtInterface). For instance, it took me a few hours to realize that my implementation wasn't working because schema is, in fact, not a mandatory field but rather a field limiting the amount of models being parsed and synced.

I think this is a great tool that is easily usable if you know how to, where a bit of docs could go a long way :)

gouline commented 2 years ago

Feel free to propose specific improvements. We went as far as we could with the documentation, beyond that you're welcome to PR improvements/corrections.

soltanianalytics commented 2 years ago

@gouline Sure, this is what I've been thinking: https://github.com/gouline/dbt-metabase/pull/85

Does that make sense to you?

Happy to update the PR with the missing descriptions if you let me know what makes most sense for them

soltanianalytics commented 2 years ago

Solved