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

Explain specifying project dependencies independent of package dependencies #6176

Open
1 task done
dbeatty10 opened this issue Sep 30, 2024 · 0 comments
Open
1 task done
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

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/docs/collaborate/govern/project-dependencies

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

As described here, dbt has two types of dependencies:

  1. Package dependencies
  2. Project dependencies

Here's what each of them look like:

# Packages

packages:
  - package: dbt-labs/dbt_utils
    version: 1.1.1
# Projects

projects:
  - name: jaffle_finance  # case sensitive and matches the 'name' in the 'dbt_project.yml'

👉 The problem that would be great to solve:

  • There is a stand-alone section describing "How do I specify a package?", but there does not exist a stand-alone section describing "How do I specify a project dependency?".

I think we should do the following:

  1. Add that stand-alone section somewhere (probably within this page)
  2. Link "Package" dependencies here to that section
  3. Link "Project" dependencies here to this section

That way, the links show exactly how to specify each type of dependency in a stand-alone fashion. Then a user can see how to specify them either in separate files (packages.yml and dependencies.yml) or the same file (dependencies.yml).

Additional information

No response

@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 Sep 30, 2024
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

No branches or pull requests

1 participant