Clarify which node / resource types support node_color

[mirnawong1]

clarifies which node type supports node_color. Resolves #4492

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-getdbt-com	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 10, 2024 6:00pm

[mirnawong1]

hey @dbeatty10 ! could i ask you to review this pr to make sure it addresses your issues?

[mirnawong1]

hey @dbeatty10 wanted to check in on what your thoughts were on this pr?

[dbeatty10]

Could we add example code for node_color: color_id for each of these node types?

• models
• seeds
• snapshots
• analyses

Per #4492 (comment), these are the (4) node / resource types that support using node_color.

And also make sure the example configuration appears in both of these file examples for each node type?

• dbt_project.yml
• schema.yml

So (8) places total 😅

Here's the only one out of the eight that exists currently:

models/schema.yml

version: 2

models:
- name: model_name
  docs:
    show: true | false
    node_color: "black"

To be consistent with example code for other configs/properties, we'd probably want to change "black" to a placeholder like color_id.

[mirnawong1]

hey @dbeatty10 amazing feedback! i've added it here and folded it all in. one thing i think we should add:

• it looks like the ide dag doesn't reflect the node color changes and you need to run dbt docs generate to see them. is that right? if so, it's pretty manual and i wonder if i should let product know and also flag this in the docs that they should run the command to see it.

[dbeatty10]

Made the same suggestion (4) times -- once for each of the (4) *-properties.md files.

Didn't make the same suggestion for resource-configs/docs.md because it isn't currently using the <...> convention.

[dbeatty10]

Eagle eyes! 🦅

[dbeatty10]

one thing i think we should add:

• it looks like the ide dag doesn't reflect the node color changes and you need to run dbt docs generate to see them. is that right? if so, it's pretty manual and i wonder if i should let product know and also flag this in the docs that they should run the command to see it.

Good catch! Makes sense to do both of these:

1. Add any relevant instructions how to make any changes display (i.e., re-run dbt docs generate)
2. Let product know