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

clarify cross project ref pages/headers #4695

Merged
merged 5 commits into from
Jan 2, 2024
Merged

Conversation

mirnawong1
Copy link
Contributor

this pr adds or rewrites headers so 'cross project ref' is explicit for users and easier to search. previously there were no clear headers or sections on pages that referenced 'cross project ref' so it wasn't 100% clear where to read up on this.

the PR also adds keywords for better searching/discoverability.

Previously

For example, the following pages refer to 'ref' and were the main pages to read up on cross project ref. however it didn't explicitly state that:

  • https://docs.getdbt.com/docs/collaborate/govern/project-dependencies#how-to-use-ref
  • https://docs.getdbt.com/reference/dbt-jinja-functions/ref#two-argument-variant

Proposed

I'm now proposing to be more explicit in the headers by adding 'cross project ref or ref models':

  • /docs/collaborate/govern/project-dependencies#how-to-write-cross-project-ref
  • /reference/dbt-jinja-functions/ref/#ref-project-specific-models

@mirnawong1 mirnawong1 requested a review from a team as a code owner January 2, 2024 15:17
Copy link

vercel bot commented Jan 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 2, 2024 8:36pm

@github-actions github-actions bot added content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: small This change will take 1 to 2 days to address labels Jan 2, 2024
Copy link
Collaborator

@jtcohen6 jtcohen6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick work on this @mirnawong1!

fold jeremy's feedback without changing header
@mirnawong1 mirnawong1 enabled auto-merge January 2, 2024 20:32
@mirnawong1 mirnawong1 merged commit 7ae1178 into current Jan 2, 2024
7 checks passed
@mirnawong1 mirnawong1 deleted the mwong-cross-project-ref branch January 2, 2024 20:36
Copy link
Contributor

github-actions bot commented Jan 2, 2024

Check your created Crawler

Check your created index on your Algolia Application

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 Docs team Authored by the Docs team @dbt Labs January-2024 size: small This change will take 1 to 2 days to address trigger-crawl
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants