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

Standardize the order of code examples for dbt_project.yml vs. properties.yml #4417

Closed
1 task done
dbeatty10 opened this issue Nov 8, 2023 · 0 comments · Fixed by #4456
Closed
1 task done

Standardize the order of code examples for dbt_project.yml vs. properties.yml #4417

dbeatty10 opened this issue Nov 8, 2023 · 0 comments · Fixed by #4456
Assignees
@matthewshaver
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear size: medium This change will take up to a week to address

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

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

Here's an example where dbt_project.yml is first and models/_.yml is second:

image

My initial instinct is that this should be the order to standardize upon, but we could choose the other way around if we want to.

Let's pick an order and stick with it.

Here's an example where the order is opposite:

image

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 Nov 8, 2023
@dbeatty10 dbeatty10 mentioned this issue Nov 8, 2023
Merged
3 tasks
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 matthewshaver self-assigned this Nov 9, 2023
@matthewshaver matthewshaver added the size: medium This change will take up to a week to address label Nov 9, 2023
@matthewshaver matthewshaver mentioned this issue Nov 13, 2023
Merged
2 tasks
matthewshaver added a commit that referenced this issue Nov 13, 2023
@matthewshaver
Updating order of examples (#4456)
bd154df 
## What are you changing in this pull request and why?

Standardizes the `project.yml` file as the first example on a few pages
where it's listed after the `models` example.

Closes #4417

## 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."
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 improvement Use this when an area of the docs needs improvement as it's currently unclear size: medium This change will take up to a week to address
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Updating order of examples dbt-labs/docs.getdbt.com
2 participants
@dbeatty10 @matthewshaver