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

The resource-path configuration applies to many (all?) resource types #4313

Closed
1 task done
dbeatty10 opened this issue Oct 23, 2023 · 1 comment · Fixed by #4394
Closed
1 task done

The resource-path configuration applies to many (all?) resource types #4313

dbeatty10 opened this issue Oct 23, 2023 · 1 comment · Fixed by #4394
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@dbeatty10
Copy link
Contributor

dbeatty10 commented Oct 23, 2023

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

https://docs.getdbt.com/reference/resource-configs/resource-path

What part(s) of the page would you like to see updated?

The resource-path page only explains how it applies to:

  • models
  • seeds
  • snapshots

But it applies to other resource types as well:

  • tests
  • sources
  • potentially others

Additional information

The problem

dbt-labs/dbt-core#8876 specifically mentioned that they were expecting this section to apply to tests also:

The <resource-path> nomenclature is used in this documentation when documenting how to configure a model, seed, or snapshot, from your dbt_project.yml file. It represents the nested dictionary keys that provide the path to either a directory of models, or a single model.

The "info" section is also relevant:

This example is for models, but the same concepts apply for seeds and snapshots.

But these sections only explain three node types and don't cover the other ones.

Potential solution

The key insight is that it should be something like this instead:

It represents the nested dictionary keys that provide the path to a directory of that resource type, or a single instance of that resource type by name.

e.g.

<resource type>:
  <project name>:
    <directory name>:
      <subdirectory name>:
        <instance of resource type (by name)>:
          ...

Related issues

@dbeatty10 dbeatty10 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Oct 23, 2023
@mirnawong1
Copy link
Contributor

hey @dbeatty10 ! thank you for this, I've created a PR here which addresses the above and also other items such as this this core issue

mirnawong1 added a commit that referenced this issue Nov 7, 2023
PR clarifies how to disable sources and addresses core issue
dbt-labs/dbt-core#8960 and adds the resource
paths page to the sidebar.

This also Resolves #4313
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants