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

Improve the documentation for dispatch macros #918

Open
dbeatty10 opened this issue Jun 10, 2024 · 1 comment
Open

Improve the documentation for dispatch macros #918

dbeatty10 opened this issue Jun 10, 2024 · 1 comment

Comments

@dbeatty10
Copy link
Contributor

Describe the documentation request

Improve the documentation for dispatch macros for two audiences:

  1. Users of community-supported adapter plugins
  2. Maintainers of community-supported adapter plugins

Also clarify which dbt adapters dbt_utils supports directly and which will need to be dispatched from a separate package.

Additional context

Users

Users need to know if there is already a package containing dispatched macros for the adapter they are using. If there is one, then they will want to know how to install and use it. If there is not one, they will want to know how to request one and/or how to define their own overrides for the macro(s) relevant to them.

For example, it would be great if we had documentation that we could point to in order related to the request in #891. There have been many similar requests for other macros or other adapters.

Maintainers

Maintainers need to know which dbt packages (and which macros within those packages) don't work out-of-the-box for the adapter that they maintain. Then then need to know how to publish an implementation of that functionality, how to test it, and how to document installation instructions and distribute it.

Packages of dispatched macros

Here's a sample from the dbt Package Hub:

Who will this benefit?

This is intended to primarily benefit users of community-supported adapter plugins that want to use the macros defined in dbt_utils.

But it will also benefit maintainers of those adapters as well.

Copy link

github-actions bot commented Dec 8, 2024

This issue has been marked as Stale because it has been open for 180 days with no activity. If you would like the issue to remain open, please comment on the issue or else it will be closed in 7 days.

@github-actions github-actions bot added the Stale label Dec 8, 2024
@dbeatty10 dbeatty10 removed the Stale label Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant