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

Replace placeholder for the materialized config #4694

Closed
1 task done
dbeatty10 opened this issue Dec 22, 2023 · 0 comments · Fixed by #5337
Closed
1 task done

Replace placeholder for the materialized config #4694

dbeatty10 opened this issue Dec 22, 2023 · 0 comments · Fixed by #5337
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear priority: medium Fix or enhancement to existing information that’s creating some requests from customers size: small This change will take 1 to 2 days 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?

Problem

The page currently has the following message:

🔥 DANGER
These docs are a placeholder for a yet-to-be-written reference section.

Please refer to the guide on materializations for current documentation.

image

Solution

If we update this page to have a similar style to sql_header or on_configuration_change, then we can remove the following scary message 😎

Potential content

dbt_project.yml

[config-version](/reference/project-configs/config-version): 2

models:
  [<resource-path>](/reference/resource-configs/resource-path):
    +materialized: [<materialization_name>](https://docs.getdbt.com/docs/build/materializations#materializations)

models/<modelname>.sql

{{ config(
  materialized="[<materialization_name>](https://docs.getdbt.com/docs/build/materializations#materializations)"
) }}

select ...

models/properties.yml

version: 2

models:
  - name: [<model-name>]
    config:
      [materialized](/reference/resource-configs/materialized): [<materialization_name>](https://docs.getdbt.com/docs/build/materializations#materializations)

Definition

Materializations are strategies for persisting dbt models in a warehouse. There are five types of materializations built into dbt. They are:

You can also configure custom materializations in dbt. Custom materializations are a powerful way to extend dbt's functionality to meet your specific needs.

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 Dec 22, 2023
@graciegoheen graciegoheen added priority: medium Fix or enhancement to existing information that’s creating some requests from customers size: small This change will take 1 to 2 days to address labels Jan 2, 2024
@nghi-ly nghi-ly mentioned this issue Apr 23, 2024
3 tasks
nghi-ly added a commit that referenced this issue Apr 24, 2024
## What are you changing in this pull request and why?

Updated the Materialized page (as shown below) so we can remove the
scary callout:

<img width="500" alt="Screenshot 2024-04-23 at 3 22 09 PM"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/107218380/d8a658e8-2cd9-4215-a23b-d4a4f58f9747">

closes #4694 

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [x] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [x] Needs DX review
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 priority: medium Fix or enhancement to existing information that’s creating some requests from customers size: small This change will take 1 to 2 days to address
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants