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

Resource types that are missing general configs #3957

Open
3 of 4 tasks
dbeatty10 opened this issue Aug 21, 2023 · 0 comments
Open
3 of 4 tasks

Resource types that are missing general configs #3957

dbeatty10 opened this issue Aug 21, 2023 · 0 comments
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@dbeatty10
Copy link
Contributor

dbeatty10 commented Aug 21, 2023

Contributions

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

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

As noted in #3710, these resource types only have properties pages, and they don't have configuration pages:

These resource types have neither properties nor configuration pages:

  • ❌ metrics
  • ❌ semantic models

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

There are some general configs that may be relevant:

I'd propose doing the following:

  1. Testing each of the configs above for each of the resource types that are missing config pages
  2. Create a config and/or properties page for each relevant resource type, and add docs for each relevant config
  3. Update this related documentation as appropriate to include any missing resource types and/or links

Details

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 labels Aug 21, 2023
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 added a commit that referenced this issue Nov 16, 2023
related to: #3997

## What are you changing in this pull request and why?
- Add "Semantic models" tab for `config`
- Add a "Definition" header (like other similar pages, like
[`group`](https://docs.getdbt.com/reference/resource-configs/group),
[`enabled`](https://docs.getdbt.com/reference/resource-configs/enabled),
etc.)

## Other
- Added semantic models & metrics to
[#3957](#3957)

## 🎩 

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

### v1.6

<img width="500" alt="image"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/44704949/3bee360e-7709-4dde-9d5f-a81ce5095e96">

### v1.7

<img width="500" alt="image"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/44704949/231c4b4b-e344-4757-ad93-50ec2d228e22">


## 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.

---------

Co-authored-by: mirnawong1 <[email protected]>
dbeatty10 added a commit that referenced this issue Nov 16, 2023
Resolves #4436
Resolves #4441

### Previews
-
[v1.6](https://docs-getdbt-com-git-dbeatty-semantic-layer-dbt-79c193-dbt-labs.vercel.app/reference/dbt_project.yml?version=1.6)
-
[v1.7](https://docs-getdbt-com-git-dbeatty-semantic-layer-dbt-79c193-dbt-labs.vercel.app/reference/dbt_project.yml?version=1.7)

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

The only substantive change is in
e40903c.

The rest of the diff is covered by
83a2e62, which was a duplication of the
spec from v1.6 into v1.7.

To keep this PR small and easy to merge, deferring to #3957 to flesh out
the other relevant pages for the semantic model configs and metric
configs. As part of #3957, this page should be updated with links to the
actual config pages once they are created.

### Other

Opened #4463 to figure out how many versions back we want to add
`metrics:`.

## 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 checked that the previews render correctly across versions
1.6 and 1.7
- [x] I have confirmed that these config options work in 1.7
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 improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Development

No branches or pull requests

1 participant