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

Updating description fields #6852

Open
wants to merge 13 commits into
base: current
Choose a base branch
from
Open

Updating description fields #6852

wants to merge 13 commits into from

Conversation

matthewshaver
Copy link
Contributor

@matthewshaver matthewshaver commented Jan 30, 2025

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

  • I have reviewed the Content style guide so my content adheres to these guidelines.
  • The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the version a whole page and/or version a block of content guidelines.
  • I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."
  • The content in this PR requires a dbt release note, so I added one to the release notes page.

🚀 Deployment available! Here are the direct links to the updated files:

@matthewshaver matthewshaver requested review from amychen1776 and a team as code owners January 30, 2025 04:53
Copy link

vercel bot commented Jan 30, 2025

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

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Jan 31, 2025 6:34pm

@github-actions github-actions bot added content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address labels Jan 30, 2025
Copy link
Collaborator

@runleonarun runleonarun left a 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."
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
description: "Configure custom aliases to override default naming conventions in dbt."
description: "Configure custom aliases to override default model naming conventions in dbt."

Copy link
Contributor

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."
Copy link
Collaborator

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.

Suggested change
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."

Copy link
Contributor Author

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

Suggested change
description: "Implement incremental materializations and the supported dbt adapters."
description: "Incremental strategies optimize performance by defining how to handle new and changed data."

Copy link
Collaborator

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?

website/docs/docs/build/jinja-macros.md Outdated Show resolved Hide resolved
website/docs/docs/build/materializations.md Outdated Show resolved Hide resolved
@@ -1,5 +1,6 @@
---
title: "Project variables"
description: "Use dbt project variables to configure conditional or reusable logic across models and other resources."
Copy link
Contributor

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]>
Copy link
Collaborator

@runleonarun runleonarun left a 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!

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 size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants