question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Allow documenting custom materializations in `.yml` files

See original GitHub issue

Describe the feature

Allow documenting custom materializations in .yml files

Describe alternatives you’ve considered

Currently I’m defining materializations as a list of materializations in a .yml file to have it documented in the same pull request as my code.

Additional context

There are no specs about materialization documentation as far as I know. There are for macros, for example: https://docs.getdbt.com/reference/macro-properties/. But if you define materializations as macros then dbt will warn you with: WARNING: Found documentation for macro "your_materialization" which was not found.

Who will this benefit?

All dbt users will benefit if all object types in dbt can be documented in a consistent way.

Are you interested in contributing this feature?

Let us know if you want to write some code, and how we can help.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:5 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
ilmari-aaltocommented, Oct 26, 2021

I still think this is relevant - commenting so it won’t be closed

0reactions
github-actions[bot]commented, May 2, 2022

Although we are closing this issue as stale, it’s not gone forever. Issues can be reopened if there is renewed community interest; add a comment to notify the maintainers.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Allow documenting custom materializations in .yml files #2944
Currently I'm defining materializations as a list of materializations in a .yml file to have it documented in the same pull request as...
Read more >
Materializations | dbt Developer Hub
Models can be configured with a different materialization by supplying the materialized configuration parameter as shown below. dbt_project.yml.
Read more >
dbt | Materialize Documentation
Each individual materialization should be stored as a .sql file under the directory defined by model-paths in dbt_project.yml .
Read more >
dbt Guide - GitLab
Custom SQL; Merge Request Workflow; Running the newly introduced dbt tests in ... Sensitive columns are documented in the schema.yml file using the...
Read more >
YAML Tutorial: Everything You Need to Get Started in Minutes
Let's take a look at a YAML file for a brief overview. ... These dashes indicate the start of a new YAML document....
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found