add new spec to references pages #6190

mirnawong1 · 2024-10-01T13:20:42Z

this pr adds the new snapshot yaml spec to all the snapshot-related pages under 'references'. it updaes the following:

snapshot configs page
snapshot properties page
configs and properties page
post and pre hook page
resource configs for snapshots (10 pages, such as snapshot-name, updated_at key, unique_key, etc.)

this pr should merge into the main add/new-snapshot-spec-main branch

vercel · 2024-10-01T13:20:47Z

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

Name	Status	Preview	Updated (UTC)
docs-getdbt-com	✅ Ready (Inspect)	Visit Preview	Oct 3, 2024 5:19pm

website/docs/reference/configs-and-properties.md

…reference

fix spacing

website/docs/reference/resource-configs/strategy.md

website/docs/reference/snapshot-configs.md

website/docs/reference/configs-and-properties.md

website/docs/reference/snapshot-configs.md

…reference

website/docs/reference/resource-configs/strategy.md

Co-authored-by: Doug Beatty <[email protected]>

website/docs/reference/snapshot-configs.md

…reference

website/docs/reference/resource-configs/pre-hook-post-hook.md

dbeatty10 · 2024-10-03T13:04:21Z

website/docs/reference/configs-and-properties.md

+1. Using a [`config` property](/reference/resource-properties/config) in a `.yml` file in the `models/`, `snapshots/`, `seeds/`, `analyses`, or `tests/` directory
+2. From the [`dbt_project.yml` file](dbt_project.yml), under the corresponding resource key (`models:`, `snapshots:`, `tests:`, etc)
+</VersionBlock>
+
+<VersionBlock lastVersion="1.8">
+
 1. Using a [`config()` Jinja macro](/reference/dbt-jinja-functions/config) within a `model`, `snapshot`, or `test` SQL file
-2. Using a [`config` property](/reference/resource-properties/config) in a `.yml` file
+2. Using a [`config` property](/reference/resource-properties/config) in a `.yml` file in the `models/`, `snapshots/`, `seeds/`, `analyses/`, or `tests/` directory.
 3. From the [`dbt_project.yml` file](dbt_project.yml), under the corresponding resource key (`models:`, `snapshots:`, `tests:`, etc)


Wish for a later update down the road:

it would be awesome if we didn't need to explicitly list out the relevant resource types

Maybe there's a way we could instead could link to some list of the relevant resource types that support the config property within different file types? Maybe a new section here?

I think we should table this and open up a nice-to-have issue to consider later.

created issue here

website/docs/reference/resource-configs/check_cols.md

website/docs/reference/resource-configs/snapshot_name.md

dbeatty10 · 2024-10-03T13:14:18Z

website/docs/reference/resource-configs/snapshot_name.md

I didn't realize this page existed until this week!

We should consider an action item for later if we'd want to keep this page or retire it.

Ah, now I see some other pages that link here: using a link to /reference/resource-configs/snapshot_name.

Still might be worth a 2nd look later since I don't think we have similar model_name, seed_name, etc. pages.

website/docs/reference/snapshot-configs.md

Co-authored-by: Doug Beatty <[email protected]>

…reference

Co-authored-by: Doug Beatty <[email protected]>

…reference

mirnawong1 added 3 commits October 1, 2024 12:42

update configs

b70d801

add properites adn configs

66f65b5

update all content under snapshots

c699609

mirnawong1 requested a review from a team as a code owner October 1, 2024 13:20

github-actions bot added content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: large This change will more than a week to address and might require more than one person labels Oct 1, 2024

vercel bot deployed to Preview October 1, 2024 13:21 View deployment

mirnawong1 commented Oct 1, 2024

View reviewed changes

website/docs/reference/configs-and-properties.md Outdated Show resolved Hide resolved

Update check_cols.md

b81da15

vercel bot deployed to Preview October 1, 2024 13:29 View deployment

mirnawong1 added 2 commits October 1, 2024 14:35

Update check_cols.md

dc6b25e

Merge branch 'add/new-snapshot-spec-main' into add/new-snapshot-spec-…

261dcff

…reference

vercel bot had a problem deploying to Preview October 1, 2024 13:41 Failure

Update check_cols.md

966cf41

vercel bot deployed to Preview October 1, 2024 13:48 View deployment

Update pre-hook-post-hook.md

78706d6

fix spacing

vercel bot deployed to Preview October 1, 2024 13:57 View deployment

mirnawong1 commented Oct 1, 2024

View reviewed changes

website/docs/reference/resource-configs/strategy.md Show resolved Hide resolved

mirnawong1 commented Oct 1, 2024

View reviewed changes

website/docs/reference/snapshot-configs.md Outdated Show resolved Hide resolved

dbeatty10 reviewed Oct 1, 2024

View reviewed changes

website/docs/reference/configs-and-properties.md Outdated Show resolved Hide resolved

website/docs/reference/snapshot-configs.md Outdated Show resolved Hide resolved

website/docs/reference/snapshot-configs.md Outdated Show resolved Hide resolved

Merge branch 'add/new-snapshot-spec-main' into add/new-snapshot-spec-…

1a3ff6d

…reference

vercel bot deployed to Preview October 1, 2024 16:45 View deployment

dbeatty10 reviewed Oct 1, 2024

View reviewed changes

website/docs/reference/resource-configs/strategy.md Outdated Show resolved Hide resolved

Update website/docs/reference/snapshot-configs.md

d93d65a

Co-authored-by: Doug Beatty <[email protected]>

mirnawong1 commented Oct 1, 2024

View reviewed changes

website/docs/reference/snapshot-configs.md Outdated Show resolved Hide resolved

Update website/docs/reference/snapshot-configs.md

5ef956a

vercel bot deployed to Preview October 1, 2024 17:09 View deployment

update and triple check

7f600ba

Merge branch 'add/new-snapshot-spec-main' into add/new-snapshot-spec-…

b523a38

…reference

vercel bot deployed to Preview October 2, 2024 09:44 View deployment

Merge branch 'add/new-snapshot-spec-main' into add/new-snapshot-spec-…

6b11685

…reference

vercel bot deployed to Preview October 2, 2024 11:16 View deployment

Merge branch 'add/new-snapshot-spec-main' into add/new-snapshot-spec-…

c9f9bbf

…reference

vercel bot deployed to Preview October 2, 2024 14:06 View deployment

Merge branch 'add/new-snapshot-spec-main' into add/new-snapshot-spec-…

e21535c

…reference

vercel bot deployed to Preview October 2, 2024 15:01 View deployment

dbeatty10 mentioned this pull request Oct 2, 2024

add new snapshot spec - main #6187

Merged

dbeatty10 reviewed Oct 3, 2024

View reviewed changes

mirnawong1 and others added 11 commits October 3, 2024 15:42

Update website/docs/reference/resource-configs/strategy.md

98ad8ac

Co-authored-by: Doug Beatty <[email protected]>

Update website/docs/reference/snapshot-configs.md

b0191c6

Co-authored-by: Doug Beatty <[email protected]>

Update website/docs/reference/resource-configs/unique_key.md

2076f26

Co-authored-by: Doug Beatty <[email protected]>

Update website/docs/reference/resource-configs/updated_at.md

18826b7

Co-authored-by: Doug Beatty <[email protected]>

Merge branch 'add/new-snapshot-spec-main' into add/new-snapshot-spec-…

7fbb2fe

…reference

Update website/docs/reference/snapshot-configs.md

d99fb72

Co-authored-by: Doug Beatty <[email protected]>

Update website/docs/reference/snapshot-configs.md

23bb87a

Co-authored-by: Doug Beatty <[email protected]>

Update website/docs/reference/snapshot-configs.md

2dbdeed

Co-authored-by: Doug Beatty <[email protected]>

Update website/docs/reference/snapshot-configs.md

4882c66

Co-authored-by: Doug Beatty <[email protected]>

Update website/docs/reference/snapshot-configs.md

7906a09

Co-authored-by: Doug Beatty <[email protected]>

Update website/docs/reference/snapshot-configs.md

ffc8b3f

Co-authored-by: Doug Beatty <[email protected]>

vercel bot deployed to Preview October 3, 2024 15:02 View deployment

doug's feedback

dfa67f9

vercel bot deployed to Preview October 3, 2024 16:02 View deployment

mirnawong1 added 2 commits October 3, 2024 18:08

Merge branch 'add/new-snapshot-spec-main' into add/new-snapshot-spec-…

e0d4277

…reference

Merge branch 'add/new-snapshot-spec-main' into add/new-snapshot-spec-…

3ac664e

…reference

mirnawong1 merged commit 8b5bd3b into add/new-snapshot-spec-main Oct 3, 2024
3 of 4 checks passed

mirnawong1 deleted the add/new-snapshot-spec-reference branch October 3, 2024 17:12

vercel bot deployed to Preview October 3, 2024 17:19 View deployment

mirnawong1 mentioned this pull request Oct 4, 2024

Consider a new section to list relevant resource types that support the config property #6240

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add new spec to references pages #6190

add new spec to references pages #6190

mirnawong1 commented Oct 1, 2024

vercel bot commented Oct 1, 2024 •

edited

Loading

dbeatty10 Oct 3, 2024

mirnawong1 Oct 4, 2024

dbeatty10 Oct 3, 2024

dbeatty10 Oct 3, 2024

add new spec to references pages #6190

add new spec to references pages #6190

Conversation

mirnawong1 commented Oct 1, 2024

vercel bot commented Oct 1, 2024 • edited Loading

dbeatty10 Oct 3, 2024

Choose a reason for hiding this comment

mirnawong1 Oct 4, 2024

Choose a reason for hiding this comment

dbeatty10 Oct 3, 2024

Choose a reason for hiding this comment

dbeatty10 Oct 3, 2024

Choose a reason for hiding this comment

vercel bot commented Oct 1, 2024 •

edited

Loading