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
2 changes: 1 addition & 1 deletion website/docs/docs/build/analyses.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Analyses"
description: "Read this tutorial to learn how to use custom analyses when building in dbt."
description: "Configure SQL files in dbt to create compiled code used for analyses."
id: "analyses"
pagination_next: null
---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/custom-aliases.md
Original file line number Diff line number Diff line change
@@ -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"

matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
id: "custom-aliases"
---

Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/build/custom-schemas.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Custom schemas"
description: "Configure custom schemas for your dbt model's tables and views in the database."
id: "custom-schemas"
pagination_next: "docs/build/custom-databases"
---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/data-tests.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Add data tests to your DAG"
sidebar_label: "Data tests"
description: "Read this tutorial to learn how to use data tests when building in dbt."
description: "Configure data tests in dbt to assess the quality of your input data or the resulting datasets."
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
pagination_next: "docs/build/unit-tests"
pagination_prev: null
search_weight: "heavy"
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/hooks-operations.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Hooks and operations"
description: "Read this tutorial to learn how to use hooks and operations when building in dbt."
description: "Customize dbt workflows using hooks and operations."
id: "hooks-operations"
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/incremental-models.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configure incremental models"
description: "Learn how to configure incremental models when building in dbt."
description: "Learn how to configure incremental models when developing in dbt."
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
id: "incremental-models"
keywords: ["incremental models", "incremental materialization","incremental", "materialization", "incremental model", "incremental strategy", "incremental model configuration"]
---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/incremental-strategy.md
Original file line number Diff line number Diff line change
@@ -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?

id: "incremental-strategy"
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/jinja-macros.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Jinja and macros"
description: "Read this tutorial to learn how to use jinja and macros when building in dbt."
description: "Use Jinja and macros when developing in dbt to create reusable assets."
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
id: "jinja-macros"
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/materializations.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Materializations"
description: "Read this tutorial to learn how to use materializations when building in dbt."
description: "Configure materializations in dbt to determine how the SQL is run and resulting data is stored."
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
id: "materializations"
pagination_next: "docs/build/incremental-models"
---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/models.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "About dbt models"
description: "Read this tutorial to learn how to use models when building in dbt."
description: "About the dbt model's role in transforming your data."
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
id: "models"
pagination_next: "docs/build/sql-models"
pagination_prev: null
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/packages.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Packages"
id: "packages"
description: "Discover how dbt packages help modularize code and transform data efficiently. Learn about git packages, hub packages, private packages, and advanced package configurations."
description: "dbt packages help modularize code and transform data efficiently."
keywords: [dbt package, private package, dbt private package, dbt data transformation, dbt clone, add dbt package]
---

Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/build/project-variables.md
Original file line number Diff line number Diff line change
@@ -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.

🔥

id: "project-variables"
pagination_next: "docs/build/environment-variables"
---
Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/build/python-models.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Python models"
description: "Python models further enhance your dbt project."
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
id: "python-models"
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/seeds.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Add Seeds to your DAG"
sidebar_label: "Seeds"
description: "Read this tutorial to learn how to use seeds when building in dbt."
description: "Provide seed data files for your dbt models."
id: "seeds"
---
## Related reference docs
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/snapshots.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Add snapshots to your DAG"
sidebar_label: "Snapshots"
description: "Read this tutorial to learn how to use snapshots when building in dbt."
description: "Configure snapshots in dbt to track changes to your data over time."
id: "snapshots"
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/sources.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Add sources to your DAG"
sidebar_label: "Sources"
description: "Read this tutorial to learn how to use sources when building in dbt."
description: "Define data source tables when developing in dbt."
id: "sources"
search_weight: "heavy"
---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/sql-models.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "SQL models"
description: "Read this tutorial to learn how to use SQL models when building in dbt."
description: "SQL models are the building blocks of your dbt project."
id: "sql-models"
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/unit-tests.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Unit tests"
sidebar_label: "Unit tests"
description: "Learn how to use unit tests on your SQL models."
description: "Implement unit tests to validate your dbt code."
search_weight: "heavy"
id: "unit-tests"
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Connection profiles"
id: "connection-profiles"
description: "Configure your profile using the command line."
description: "Configure the connection profile for your dbt project."
---

When you invoke dbt from the command line, dbt parses your `dbt_project.yml` and obtains the `profile` name, which dbt needs to connect to your <Term id="data-warehouse" />.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "About profiles.yml"
description: "The dbt profiles.yml file contains the connection details for your data warehouse.
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
id: profiles.yml
---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/core/installation-overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "About dbt Core and installation"
description: "You can install dbt Core using a few different tested methods."
description: "Install dbt Core locally to begin transforming your data."
pagination_next: "docs/core/pip-install"
pagination_prev: null
---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/core/pip-install.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Install with pip"
description: "You can use pip to install dbt Core and adapter plugins from the command line."
description: "Install dbt Core and adapter plugins from the command line with pip."
---

You need to use `pip` to install dbt Core on Windows, Linux, or MacOS operating systems.
Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "What is dbt?"
id: "introduction"
description: "Welcome to dbt!"
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
pagination_next: null
pagination_prev: null
---
Expand Down
1 change: 1 addition & 0 deletions website/docs/reference/commands/cmd-docs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "About dbt docs commands"
description: "Generate and serve the docs for your dbt project."
sidebar_label: "docs"
id: "cmd-docs"
---
Expand Down
1 change: 1 addition & 0 deletions website/docs/reference/commands/compile.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "About dbt compile command"
description: "The dbt compile command creates executable SQL from model, test, and analysis files."
sidebar_label: "compile"
id: "compile"
---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/commands/run.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "About dbt run command"
sidebar_label: "run"
description: "Read this guide on how dbt's run command can be used to execute compiled SQL model files against a target database."
description: "The dbt run command executes your compiled SQL models against a target database."
id: "run"
---

Expand Down
3 changes: 3 additions & 0 deletions website/docs/reference/dbt_project.yml.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: "Reference guide for configuring the dbt_project.yml file."
---

Every [dbt project](/docs/build/projects) needs a `dbt_project.yml` file — this is how dbt knows a directory is a dbt project. It also contains important information that tells dbt how to operate your project.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/model-configs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Model configurations
description: "Read this guide to understand model configurations in dbt."
description: "Reference guide for the model configs available in dbt."
meta:
resource_type: Models
---
Expand Down
1 change: 1 addition & 0 deletions website/docs/reference/node-selection/syntax.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Syntax overview"
description: "Node selection syntax enables you to execute dbt commands for specific models and resources."
---

dbt's node selection syntax makes it possible to run only specific resources in a given invocation of dbt. This selection syntax is used for the following subcommands:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "BigQuery configurations"
description: "Read this guide to understand BigQuery configurations in dbt."
description: "Reference guide for Big Query configurations in dbt."
id: "bigquery-configs"
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/resource-configs/full_refresh.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
resource_types: [models, seeds]
description: "Setting the full_refresh config to false prevents a model or seed from being rebuilt, even when the `--full-refresh` flag is included in an invocation."
description: "Set the full_refresh config for models and other resources in dbt."
datatype: boolean
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: pre-hook & post-hook
description: "Pre-hook and Post-hook - Read this in-depth guide to learn about configurations in dbt."
description: "Configure hooks to execute SQL before(pre) and after(post) a model is run in dbt."
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
resource_types: [models, seeds, snapshots]
datatype: sql-statement | [sql-statement]
---
Expand Down
1 change: 1 addition & 0 deletions website/docs/reference/resource-configs/tags.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Configure tags to label and organize your dbt models and resources."
sidebar_label: "tags"
resource_types: all
datatype: string | [string]
Expand Down
1 change: 1 addition & 0 deletions website/docs/reference/resource-properties/data-tests.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "About data tests property"
description: "Reference guide for the resource properties available for data tests in dbt."
sidebar_label: "Data tests"
resource_types: all
datatype: data-test
Expand Down
Loading