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

add config descriptions per user feedback #4448

Merged
merged 17 commits into from
Nov 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions website/docs/reference/model-configs.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
---
title: Model configurations
description: "Read this guide to understand model configurations in dbt."
meta:
resource_type: Models
---

import ConfigResource from '/snippets/_config-description-resource.md';
import ConfigGeneral from '/snippets/_config-description-general.md';

## Related documentation
* [Models](/docs/build/models)
* [`run` command](/reference/commands/run)

## Available configurations
### Model-specific configurations

<ConfigResource meta={frontMatter.meta}/>

<Tabs
groupId="config-languages"
defaultValue="project-yaml"
Expand Down Expand Up @@ -78,6 +85,8 @@ models:

### General configurations

<ConfigGeneral />

<Tabs
groupId="config-languages"
defaultValue="project-yaml"
Expand Down
10 changes: 10 additions & 0 deletions website/docs/reference/seed-configs.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
---
title: Seed configurations
description: "Read this guide to learn about using seed configurations in dbt."
meta:
resource_type: Seeds
---

import ConfigResource from '/snippets/_config-description-resource.md';
import ConfigGeneral from '/snippets/_config-description-general.md';


## Available configurations
### Seed-specific configurations

<ConfigResource meta={frontMatter.meta} />

<Tabs
groupId="config-languages"
defaultValue="project-yaml"
Expand Down Expand Up @@ -56,6 +64,8 @@ seeds:

### General configurations

<ConfigGeneral />

<Tabs
groupId="config-languages"
defaultValue="project-yaml"
Expand Down
11 changes: 11 additions & 0 deletions website/docs/reference/snapshot-configs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
---
title: Snapshot configurations
description: "Read this guide to learn about using snapshot configurations in dbt."
meta:
resource_type: Snapshots
---

import ConfigResource from '/snippets/_config-description-resource.md';
import ConfigGeneral from '/snippets/_config-description-general.md';


## Related documentation
* [Snapshots](/docs/build/snapshots)
* The `dbt snapshot` [command](/reference/commands/snapshot)
Expand All @@ -15,6 +22,8 @@ Parts of a snapshot:
## Available configurations
### Snapshot-specific configurations

<ConfigResource meta={frontMatter.meta} />

<Tabs
groupId="config-languages"
defaultValue="project-yaml"
Expand Down Expand Up @@ -95,6 +104,8 @@ snapshots:

### General configurations

<ConfigGeneral />

<Tabs
groupId="config-languages"
defaultValue="project-yaml"
Expand Down
4 changes: 4 additions & 0 deletions website/docs/reference/source-configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@ description: "Learn how to use source configurations in dbt."
id: source-configs
---

import ConfigGeneral from '/snippets/_config-description-general.md';

## Available configurations

Sources only support one configuration, [`enabled`](/reference/resource-configs/enabled).

### General configurations

<ConfigGeneral />

<Tabs
groupId="config-languages"
defaultValue="project-yaml"
Expand Down
9 changes: 9 additions & 0 deletions website/docs/reference/test-configs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
title: Test configurations
description: "Read this guide to learn about using test configurations in dbt."
meta:
resource_type: Tests
---
import ConfigResource from '/snippets/_config-description-resource.md';
import ConfigGeneral from '/snippets/_config-description-general.md';


## Related documentation

Expand All @@ -20,6 +25,8 @@ Click the link on each configuration option to read more about what it can do.

### Test-specific configurations

<ConfigResource meta={frontMatter.meta} />

<Tabs
groupId="config-languages"
defaultValue="project-yaml"
Expand Down Expand Up @@ -114,6 +121,8 @@ This configuration mechanism is supported for specific instances of generic test

### General configurations

<ConfigGeneral />

<Tabs
groupId="config-languages"
defaultValue="project-yaml"
Expand Down
1 change: 1 addition & 0 deletions website/snippets/_config-description-general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
General configurations provide broader operational settings applicable across multiple resource types. Like resource-specific configurations, these can also be set in the project file, property files, or within resource-specific files.
3 changes: 3 additions & 0 deletions website/snippets/_config-description-resource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Resource-specific configurations are applicable to only one dbt resource type rather than multiple resource types. You can define these settings in the project file (`dbt_project.yml`), a property file (`models/properties.yml` for models, similarly for other resources), or within the resource’s file using the `{{ config() }}` macro.<br />

<span>The following resource-specific configurations are only available to {props.meta.resource_type}</span>:
Loading