diff --git a/website/docs/reference/analysis-properties.md b/website/docs/reference/analysis-properties.md index 880aeddbb0d..1601c817830 100644 --- a/website/docs/reference/analysis-properties.md +++ b/website/docs/reference/analysis-properties.md @@ -18,6 +18,7 @@ analyses: [description](/reference/resource-properties/description): [docs](/reference/resource-configs/docs): show: true | false + node_color: # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32") config: [tags](/reference/resource-configs/tags): | [] columns: diff --git a/website/docs/reference/model-properties.md b/website/docs/reference/model-properties.md index 65f9307b5b3..46fb0ca3bad 100644 --- a/website/docs/reference/model-properties.md +++ b/website/docs/reference/model-properties.md @@ -16,6 +16,7 @@ models: [description](/reference/resource-properties/description): [docs](/reference/resource-configs/docs): show: true | false + node_color: # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32") [latest_version](/reference/resource-properties/latest_version): [deprecation_date](/reference/resource-properties/deprecation_date): [access](/reference/resource-configs/access): private | protected | public diff --git a/website/docs/reference/resource-configs/docs.md b/website/docs/reference/resource-configs/docs.md index d5f7b6499d8..bb0f3714dd4 100644 --- a/website/docs/reference/resource-configs/docs.md +++ b/website/docs/reference/resource-configs/docs.md @@ -30,6 +30,7 @@ models: [](/reference/resource-configs/resource-path): +docs: show: true | false + node_color: color_id # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32") ``` @@ -44,7 +45,7 @@ models: - name: model_name docs: show: true | false - node_color: "black" + node_color: color_id # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32") ``` @@ -67,7 +68,7 @@ seeds: [](/reference/resource-configs/resource-path): +docs: show: true | false - + node_color: color_id # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32") ``` @@ -81,6 +82,7 @@ seeds: - name: seed_name docs: show: true | false + node_color: color_id # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32") ``` @@ -97,6 +99,7 @@ snapshots: [](/reference/resource-configs/resource-path): +docs: show: true | false + node_color: color_id # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32") ``` @@ -111,6 +114,7 @@ snapshots: - name: snapshot_name docs: show: true | false + node_color: color_id # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32") ``` @@ -130,6 +134,7 @@ analyses: - name: analysis_name docs: show: true | false + node_color: color_id # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32") ``` @@ -156,7 +161,7 @@ macros: ## Definition -The docs field can be used to provide documentation-specific configuration to models. It supports the doc attribute `show`, which controls whether or not models are shown in the auto-generated documentation website. It also supports `node_color` for some node types. +The docs field can be used to provide documentation-specific configuration to models. It supports the doc attribute `show`, which controls whether or not models are shown in the auto-generated documentation website. It also supports `node_color` for models, seeds, snapshots, and analyses. Other node types are not supported. **Note:** Hidden models will still appear in the dbt DAG visualization but will be identified as "hidden.” @@ -204,9 +209,9 @@ models: ## Custom node colors -The `docs` attribute now supports `node_color` to customize the display color of some node types in the DAG within dbt docs. You can define node colors in the files below and apply overrides where needed. +The `docs` attribute now supports `node_color` to customize the display color of some node types in the DAG within dbt docs. You can define node colors in the following files and apply overrides where needed. Note, you need to run or re-run the command `dbt docs generate`. -`node_color` hiearchy: +`node_color` hierarchy: `` overrides `schema.yml` overrides `dbt_project.yml` diff --git a/website/docs/reference/seed-properties.md b/website/docs/reference/seed-properties.md index 9201df65f4c..ebe222dd11c 100644 --- a/website/docs/reference/seed-properties.md +++ b/website/docs/reference/seed-properties.md @@ -16,6 +16,7 @@ seeds: [description](/reference/resource-properties/description): [docs](/reference/resource-configs/docs): show: true | false + node_color: # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32") [config](/reference/resource-properties/config): [](/reference/seed-configs): [tests](/reference/resource-properties/data-tests): diff --git a/website/docs/reference/snapshot-properties.md b/website/docs/reference/snapshot-properties.md index 8f01fd8e988..49769af8f6d 100644 --- a/website/docs/reference/snapshot-properties.md +++ b/website/docs/reference/snapshot-properties.md @@ -20,6 +20,7 @@ snapshots: [meta](/reference/resource-configs/meta): {} [docs](/reference/resource-configs/docs): show: true | false + node_color: # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32") [config](/reference/resource-properties/config): [](/reference/snapshot-configs): [tests](/reference/resource-properties/data-tests):