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.

Sign up for GitHub

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

Jump to bottom

Double-check config syntax for semantic models and metrics #4281

Closed
1 task done
dbeatty10 opened this issue Oct 13, 2023 · 2 comments
Closed
1 task done

Double-check config syntax for semantic models and metrics #4281

dbeatty10 opened this issue Oct 13, 2023 · 2 comments
Assignees
@matthewshaver
Labels
content Improvements or additions to content dbt-core v1.7 Docs impact for the v1.7 release (Oct 2023) improvement Use this when an area of the docs needs improvement as it's currently unclear
Milestone
dbt Core v1.7 Doc...

Comments

@dbeatty10
Copy link
Contributor

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

See below.

What part(s) of the page would you like to see updated?

Within the description for #4180, I added some examples of what I guessed the syntax would be, but I didn't specify that these were completely unverified guesses 😬.

So we'll want to double-check if they all work or not and fix them as-needed.

Additional information

No response
@dbeatty10 dbeatty10 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear dbt-core v1.7 Docs impact for the v1.7 release (Oct 2023) labels Oct 13, 2023
@dbeatty10 dbeatty10 added this to the dbt Core v1.7 Documentation milestone Oct 13, 2023
@matthewshaver matthewshaver self-assigned this Oct 16, 2023
This was referenced Nov 8, 2023
Merged
Merged
Merged
@dbeatty10
Copy link
Contributor Author

@matthewshaver and @graciegoheen This issue can be closed as resolved if these PRs are merged:

matthewshaver added a commit that referenced this issue Nov 8, 2023
@matthewshaver
group config for semantic models (#4220)
3f5133c 
related to: #3997
related to: #4281

## What are you changing in this pull request and why?
- Fix version blocks for other resource types
- Match the style for other resource types for
`models/semantic_models.yml`
- Fix code example in `dbt_project.yml` to refer to `semantic-models`
(since `semantic_models` won't work)
- Simplify the definition by removing an explicit listing of applicable
resource types
- rather than adding the missing ones (like seeds and semantic models)

## Other
- Opened an issue to standardize the order of code examples for
`dbt_project.yml` vs. `properties.yml`:
[#4417](#4417)
- Opened an issue to figure out: do analyses _really_ have a `group`
config?1
[#4416](#4416)
- Opened an issue to standardize on `<group_name>` instead of `finance`
in generic syntax examples
[#4418](#4418)

## 🎩

### Previews
-
[1.6](https://docs-getdbt-com-git-dbeatty-semantic-models-gro-95bd63-dbt-labs.vercel.app/reference/resource-configs/group?version=1.6)
-
[1.7](https://docs-getdbt-com-git-dbeatty-semantic-models-gro-95bd63-dbt-labs.vercel.app/reference/resource-configs/group?version=1.7)

### v1.7

<img width="500" alt="image"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/44704949/73ad131a-2ec2-4e90-b04a-d9ccd41cb18f">

## Checklist
- [x] I have tested that the code examples work
- [x] I have tested that the changes look correct in the Vercel preview
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
so my content adheres to these guidelines.
matthewshaver added a commit that referenced this issue Nov 8, 2023
@matthewshaver
enabled config for semantic models (#4219)
4e63205 
related to: #3997
related to: #4281

## What are you changing in this pull request and why?
- Add an example for config in `dbt_project.yml`
- Match the style for other resource types for
`models/semantic_models.yml`
- Simplify the definition by removing the explicit listing of applicable
resource types
- rather than bring it up-to-date by adding sources, metrics, and
exposures

## 🎩 

### Previews
-
[1.6](https://docs-getdbt-com-git-dbeatty-semantic-models-ena-f0b17e-dbt-labs.vercel.app/reference/resource-configs/enabled?version=1.6)
-
[1.7](https://docs-getdbt-com-git-dbeatty-semantic-models-ena-f0b17e-dbt-labs.vercel.app/reference/resource-configs/enabled?version=1.7)

### v1.7

<img width="500" alt="image"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/44704949/c63a2128-77c6-48ec-b498-76e1e5f6d02b">

## Checklist
- [x] I have tested that the code examples work
- [x] I have tested that the changes look correct in the Vercel preview
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
so my content adheres to these guidelines.
matthewshaver added a commit that referenced this issue Nov 8, 2023
@matthewshaver
meta config for semantic models (#4218)
cfca7c4 
related to: #4180
related to: #4281

## What are you changing in this pull request and why?
- Mention config in `dbt_project.yml` (like for models, seeds, and
snapshots)
- Match the style for other resource types for
`models/semantic_models.yml`
- Clarify that `meta` is no longer "always" available as a top-level key
(see [#8766](dbt-labs/dbt-core#8766))

## Other

- Here's an open issue to add `meta` config for metrics:
[#3957](#3957)
- Opened an issue to add version blocks for any other resource types for
which it is applicable:
[#4224](#4224)
- Opened an issue to add code examples to [`meta`
](https://docs.getdbt.com/reference/resource-configs/meta) for
`dbt_project.yml` (like
[`enabled`](https://docs.getdbt.com/reference/resource-configs/enabled)
has them):
[#4415](#4415)


## 🎩 

### Previews
-
[1.6](https://docs-getdbt-com-git-dbeatty-semantic-models-met-b30fa1-dbt-labs.vercel.app/reference/resource-configs/meta?version=1.6)
-
[1.7](https://docs-getdbt-com-git-dbeatty-semantic-models-met-b30fa1-dbt-labs.vercel.app/reference/resource-configs/meta?version=1.7)

### v1.7

<img width="500" alt="image"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/44704949/09de14e0-dd5b-40ef-8d9b-f1cd34a602a9">


## Checklist
- [x] I have tested that the code examples work
- [x] I have tested that the changes look correct in the Vercel preview
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
so my content adheres to these guidelines.
@matthewshaver
Copy link
Contributor

Merged attached PRs. Thank you Doug!

@dbeatty10 dbeatty10 mentioned this issue Nov 12, 2023
Merged
3 tasks
dbeatty10 added a commit that referenced this issue Nov 15, 2023
@dbeatty10 @mirnawong1
Fix config example for dbt_project.yml (#4443)
8694388 
## Previews
- [Semantic
models](https://docs-getdbt-com-git-dbeatty-semantic-model-conf-4886b9-dbt-labs.vercel.app/docs/build/semantic-models)

## What are you changing in this pull request and why?

Within `dbt_project.yml`, resource types have dashes (`-`) instead of
underscores (`_`), so we need to update this code example accordingly.

### Backstory

Within the description for
#4180, I added some
examples of what I _guessed_ the syntax would be, but I didn't specify
that these were completely unverified guesses 😬.

This particular example got missed during #4281.

### 🎩

<img width="500" alt="image"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/44704949/b270bc87-eb50-446d-9cf6-db7da5fda2a5">

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
so my content adheres to these guidelines.
- [x] I have verified that the code examples work
- [x] I have checked that the preview renders correctly

---------

Co-authored-by: mirnawong1 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@matthewshaver matthewshaver

Labels
content Improvements or additions to content dbt-core v1.7 Docs impact for the v1.7 release (Oct 2023) improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Milestone
dbt Core v1.7 Documentation
Development

No branches or pull requests
2 participants
@dbeatty10 @matthewshaver