-
Notifications
You must be signed in to change notification settings - Fork 989
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
Updating description fields #6852
base: current
Are you sure you want to change the base?
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@matthewshaver Just a few nits. Looks good otherwise! We might want @mirnawong1 to take a look too.
@@ -1,6 +1,6 @@ | |||
--- | |||
title: "Custom aliases" | |||
description: "Read this tutorial to learn how to use custom aliases when building in dbt." | |||
description: "Configure custom aliases to override default naming conventions in dbt." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
description: "Configure custom aliases to override default naming conventions in dbt." | |
description: "Configure custom aliases to override default model naming conventions in dbt." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this reads great! you can use aliases for models, but other resources as well (seeds, snapshots, etc) so i'd enhance Leona's sugg as:
description: "Override default naming conventions in dbt by configuring custom aliases for models, tests, and other resources"
@@ -1,7 +1,7 @@ | |||
--- | |||
title: "About incremental strategy" | |||
sidebar_label: "About incremental strategy" | |||
description: "Learn about the various ways (strategies) to implement incremental materializations." | |||
description: "Implement incremental materializations and the supported dbt adapters." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about talking about "optimization" and talking about the new/changed data, which is key to incremental strategy.
description: "Implement incremental materializations and the supported dbt adapters." | |
description: Use an incremental strategy to optimize performance by defining how incremental materializations handle new and changed data." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thinking about how we can shorten this. How about
description: "Implement incremental materializations and the supported dbt adapters." | |
description: "Incremental strategies optimize performance by defining how to handle new and changed data." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@matthewshaver I like that rewrite but wonder if we should include "materializations". in the title as a good key word. I think Joey mentioned the limit is 150 so we should be good?
@@ -1,5 +1,6 @@ | |||
--- | |||
title: "Project variables" | |||
description: "Use dbt project variables to configure conditional or reusable logic across models and other resources." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔥
Co-authored-by: Mirna Wong <[email protected]> Co-authored-by: Leona B. Campbell <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added some comments but approving so you can merge when you're ready!
What are you changing in this pull request and why?
See internal discussion https://dbt-labs.slack.com/archives/C02NCQ9483C/p1738179049488449
Updating descriptions to (hopefully) better represent what the feature is or what the purpose of the page is.
Checklist
🚀 Deployment available! Here are the direct links to the updated files: