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

Link to reference/resource-configs/schema#tests #4434

Merged
merged 2 commits into from
Nov 10, 2023

Conversation

gatewaycat
Copy link
Contributor

What are you changing in this pull request and why?

Current text reads "you can configure the schema to a different value," alluding to https://docs.getdbt.com/reference/resource-configs/schema#tests, but does not link to it. Adding such a link.

I believe this link will help dbt practitioners find the --store-failures schema configuration, in particular because when you google "--store-failures schema," this page https://docs.getdbt.com/reference/resource-configs/store_failures is the 1st result, but the page you actually want https://docs.getdbt.com/reference/resource-configs/schema#tests does not appear at all, as google hides it "In order to show you the most relevant results, we have omitted some entries very similar to the 100 already displayed." This has been the case since at least 2022.

In the existing text "you can configure the schema to a different value," I added the link to the word "configure." This seemed consistent with other links on this page. However, if you believe a different word should get the link, or a wordier addition should be made such as "For more information, refer to the schema configurations" (with the link going on "schema configurations"), or something similar, please do go ahead and make the adjustment as you see fit, or ask me to do it in a comment.

Checklist

  • Review the Content style guide and About versioning so my content adheres to these guidelines.
  • Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."

Current text reads "you can configure the schema to a different value," alluding to https://docs.getdbt.com/reference/resource-configs/schema#tests, but does not link to it. Adding such a link.

I believe this link will help dbt practitioners find the --store-failures schema configuration, in particular because when you google "--store-failures schema," this page https://docs.getdbt.com/reference/resource-configs/store_failures is the 1st result, but the page you actually want https://docs.getdbt.com/reference/resource-configs/schema#tests does not appear at all, as google hides it "In order to show you the most relevant results, we have omitted some entries very similar to the 100 already displayed." This has been the case since at least 2022.
@gatewaycat gatewaycat requested a review from a team as a code owner November 10, 2023 05:45
Copy link

welcome bot commented Nov 10, 2023

Hello!👋 Thanks for contributing to the dbt product documentation and opening this pull request! ✨
We use Markdown and some HTML to write the dbt product documentation. When writing content, you can use our style guide and content types to understand our writing standards and how we organize information in the dbt product docs.
We'll review your contribution and respond as soon as we can. 😄

Copy link

vercel bot commented Nov 10, 2023

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 Nov 10, 2023 10:14pm

@runleonarun runleonarun added the new contributor Label for first-time contributors label Nov 10, 2023
@github-actions github-actions bot added content Improvements or additions to content size: x-small This change will take under 3 hours to fix. labels Nov 10, 2023
Copy link
Contributor

@matthewshaver matthewshaver left a comment

Choose a reason for hiding this comment

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

Great suggestion. Thanks @gatewaycat

@matthewshaver matthewshaver merged commit 783cb9f into dbt-labs:current Nov 10, 2023
4 checks passed
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 new contributor Label for first-time contributors size: x-small This change will take under 3 hours to fix.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants