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

Supported configs (meta, enabled, group) for semantic models #4180

Closed
FishtownBuildBot opened this issue Oct 4, 2023 · 1 comment · Fixed by #4231
Closed

Supported configs (meta, enabled, group) for semantic models #4180

FishtownBuildBot opened this issue Oct 4, 2023 · 1 comment · Fixed by #4231
Assignees
Labels
content Improvements or additions to content dbt Core The changes proposed in this issue relate to dbt Core 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

Comments

@FishtownBuildBot
Copy link

FishtownBuildBot commented Oct 4, 2023

At a minimum, update body to include a link to the page on docs.getdbt.com requiring updates and what part(s) of the page you would like to see updated.

Relevant PRs: dbt-labs/dbt-core#8754, dbt-labs/dbt-core#8766

Pages to update:

New things for semantic_models:

  • meta can now be nested under a config key (config added in #8754)
  • enabled can now be nested under a config key (config added in #8502)
  • group can now be nested under a config key (config added in #8502)

Examples

This page should add a "Semantic models" tab that includes an example like the following:

models/semantic_models.yml

semantic_models:
  - name: semantic_people
    model: ref('people')
    config:
      meta: {<dictionary>}

And this page should have an example like this:

models/semantic_models.yml

semantic_models:
  - name: semantic_people
    model: ref('people')
    config:
      enabled: false

And this page include examples like this:

schema.yml

semantic_models:
  - name: model_name
    config:
      group: finance

dbt_project.yml

semantic-models:
  [<resource-path>](resource-path):
    +group: finance
@runleonarun runleonarun 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 The changes proposed in this issue relate to dbt Core labels Oct 4, 2023
@dbeatty10 dbeatty10 added the dbt-core v1.7 Docs impact for the v1.7 release (Oct 2023) label Oct 7, 2023
@dbeatty10 dbeatty10 added this to the dbt Core v1.7 Documentation milestone Oct 7, 2023
@matthewshaver matthewshaver linked a pull request Oct 9, 2023 that will close this issue
2 tasks
@jtcohen6 jtcohen6 changed the title Docs Changes Needed from dbt-core PR #8754 Supported configs (meta, enabled, group) for semantic models Oct 11, 2023
matthewshaver added a commit that referenced this issue Oct 11, 2023
## What are you changing in this pull request and why?

Addresses issue #4180

## 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] Add a checklist item for anything that needs to happen before this
PR is merged, such as "needs technical review" or "change base branch."
matthewshaver added a commit that referenced this issue Nov 8, 2023
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.
@dbeatty10
Copy link
Contributor

In case anyone uses this issue description for its code examples, I just now fixed the code examples that I originally wrote incorrectly.

dbeatty10 added a commit that referenced this issue Nov 15, 2023
## 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
Labels
content Improvements or additions to content dbt Core The changes proposed in this issue relate to dbt Core 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
Development

Successfully merging a pull request may close this issue.

4 participants